Liking cljdoc? Tell your friends :D

com.blockether.vis.internal.gateway.server.fs

File-system routes: directory browsing, workspace roots, and reading or opening a session's files.

File-system routes: directory browsing, workspace roots, and reading or opening
a session's files.
raw docstring

attachment-ticketclj

(attachment-ticket sid iid idx expires)

The ticket for attachment idx of iteration iid in sid, until expires. Its first line is the word attachment and a content ticket starts with a session id, so one kind of ticket can never stand for the other.

The ticket for attachment `idx` of iteration `iid` in `sid`, until `expires`.
Its first line is the word `attachment` and a content ticket starts with a
session id, so one kind of ticket can never stand for the other.
sourceraw docstring

content-dispositionclj

(content-disposition filename download?)

The Content-Disposition value that names filename in RFC 8187 form. A browser shows the file inline when it can, or saves it when download? is true.

The `Content-Disposition` value that names `filename` in RFC 8187 form. A browser
shows the file `inline` when it can, or saves it when `download?` is true.
sourceraw docstring

content-ticket-request?clj

(content-ticket-request? request)

True when request asks for file content or for the bytes of a referenced attachment with a ticket. The auth and protocol gates let it through, because the handler checks the ticket itself.

True when `request` asks for file content or for the bytes of a referenced
attachment with a ticket. The auth and protocol gates let it through, because
the handler checks the ticket itself.
sourceraw docstring

file-content-responseclj

(file-content-response request file headers)

The streamed answer for file with headers: 206 for the one byte range that the Range header of request asks, 416 for a range past the end, else 200 with the whole file. The file is read in chunks while the socket takes them.

A file of a type that the gateway compresses is always whole, without Accept-Ranges: a byte range of a compressed answer names other bytes.

The streamed answer for `file` with `headers`: 206 for the one byte range that the
`Range` header of `request` asks, 416 for a range past the end, else 200 with the
whole file. The file is read in chunks while the socket takes them.

A file of a type that the gateway compresses is always whole, without
`Accept-Ranges`: a byte range of a compressed answer names other bytes.
sourceraw docstring

handlersclj

Handlers for this namespace's routes, keyed by the gateway contract's [method path].

Handlers for this namespace's routes, keyed by the gateway contract's `[method path]`.
sourceraw docstring

session-readable-fileclj

(session-readable-file sid requested)

Resolve a file using the session's live filesystem roots and read gates. The same resolver serves previews, editor opens and attachment references, so none can bypass deny rules. Returns {:file f} or {:error response}.

Resolve a file using the session's live filesystem roots and read gates. The same
resolver serves previews, editor opens and attachment references, so none can
bypass deny rules. Returns `{:file f}` or `{:error response}`.
sourceraw docstring

ticket-expiryclj

(ticket-expiry)

The epoch milliseconds at which a ticket made now expires.

The epoch milliseconds at which a ticket made now expires.
sourceraw docstring

ticket-refusalclj

(ticket-refusal request ticket-for remedy)

The 401 answer when the ticket of request is not the one that ticket-for makes from its expires, or nil. A nil ticket-for means that the request names no target, so no ticket can admit it. remedy tells the reader how to get a new address.

The 401 answer when the ticket of `request` is not the one that `ticket-for`
makes from its `expires`, or nil. A nil `ticket-for` means that the request
names no target, so no ticket can admit it. `remedy` tells the reader how to
get a new address.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close