The XML bodies of WebDAV as Hiccup and as data: multistatus, propfind, propertyupdate and error, by RFC 4918, section 14.
Names are keywords, as qname-hiccup reads them. A namespace with an
alias in the namespaces table (URI to alias, over default-namespaces)
gives keywords under its alias, e.g. :dav/getetag. Any other namespace
gives keywords under its URI, so that no name is lost, e.g. (keyword
"http://example.com/ns/" "color"), and a name in no namespace is a
plain keyword. Writing a tree gives each URI a prefix of its own.
The XML bodies of WebDAV as Hiccup and as data: multistatus, propfind, propertyupdate and error, by RFC 4918, section 14. Names are keywords, as qname-hiccup reads them. A namespace with an alias in the `namespaces` table (URI to alias, over default-namespaces) gives keywords under its alias, e.g. :dav/getetag. Any other namespace gives keywords under its URI, so that no name is lost, e.g. (keyword "http://example.com/ns/" "color"), and a name in no namespace is a plain keyword. Writing a tree gives each URI a prefix of its own.
(clark k)(clark k namespaces)The name k in Clark notation, e.g. {DAV:}getetag for :dav/getetag,
by namespaces. A backend can keep property names as these strings,
which, unlike keywords with a URI namespace, read back from EDN.
The name `k` in Clark notation, e.g. {DAV:}getetag for :dav/getetag,
by `namespaces`. A backend can keep property names as these strings,
which, unlike keywords with a URI namespace, read back from EDN.The namespaces that every table has, from URI to alias.
The namespaces that every table has, from URI to alias.
(emit tree)(emit tree namespaces)The XML text of the Hiccup tree on one line, with names by
namespaces, so that a property's value reads back as it was. A name
that isn't an XML name, e.g. one with a space or a <, throws.
Each alias in use is declared on the root element, and each URI used as a keyword namespace gets a prefix of its own, e.g. ns1. A name in no namespace is written without a prefix.
The XML text of the Hiccup `tree` on one line, with names by `namespaces`, so that a property's value reads back as it was. A name that isn't an XML name, e.g. one with a space or a <, throws. Each alias in use is declared on the root element, and each URI used as a keyword namespace gets a prefix of its own, e.g. ns1. A name in no namespace is written without a prefix.
(error names)The DAV:error element of the preconditions or postconditions names,
e.g. [:dav/propfind-finite-depth]. An element instead of a name keeps
its content.
The DAV:error element of the preconditions or postconditions `names`, e.g. [:dav/propfind-finite-depth]. An element instead of a name keeps its content.
(multistatus {:keys [responses description sync-token] :as m})The Hiccup of the multistatus m, a map of :responses and, optionally,
:description and :sync-token.
A response is a map of its :href and either a :status or :propstats, and optionally :error, :description and :location. A propstat is a map of :status, :props (property elements) and optionally :error and :description. An :error is a sequence of precondition names or elements.
The Hiccup of the multistatus `m`, a map of :responses and, optionally, :description and :sync-token. A response is a map of its :href and either a :status or :propstats, and optionally :error, :description and :location. A propstat is a map of :status, :props (property elements) and optionally :error and :description. An :error is a sequence of precondition names or elements.
(parse s)(parse s namespaces)(parse s namespaces opts)The Hiccup of the XML text s, with names by namespaces, nested no
deeper than the :max-depth of opts, qname-hiccup's by default.
A document that isn't well-formed or namespace-well-formed throws ::malformed, and so does one that nests deeper, one with a document type, and one with a relative namespace URI. No entity is ever read.
The Hiccup of the XML text `s`, with names by `namespaces`, nested no deeper than the :max-depth of `opts`, qname-hiccup's by default. A document that isn't well-formed or namespace-well-formed throws ::malformed, and so does one that nests deeper, one with a document type, and one with a relative namespace URI. No entity is ever read.
(property name value)The element of the property name with the value: text, an element,
a sequence of children (text and elements), or nil for none.
The element of the property `name` with the `value`: text, an element, a sequence of children (text and elements), or nil for none.
(propertyupdate ops)The Hiccup of a DAV:propertyupdate for the ops, in order: [:set name
value] or [:set element] to set a property, and [:remove name] to remove
one.
The Hiccup of a DAV:propertyupdate for the `ops`, in order: [:set name value] or [:set element] to set a property, and [:remove name] to remove one.
(propfind {:keys [props propname? include] :as request})The Hiccup of a DAV:propfind for the request, a map of one of these:
With neither :props nor :propname?, it asks for allprop.
The Hiccup of a DAV:propfind for the `request`, a map of one of these: - :props, the names of the properties to get - :propname?, true for the names of all properties - :include, the names of live properties that allprop leaves out With neither :props nor :propname?, it asks for allprop.
(read-multistatus tree)The multistatus map of the Hiccup tree, as multistatus takes it, or
nil when its root isn't DAV:multistatus. A response with several hrefs
gives a map for each.
The multistatus map of the Hiccup `tree`, as multistatus takes it, or nil when its root isn't DAV:multistatus. A response with several hrefs gives a map for each.
(read-propertyupdate tree)The operations of the DAV:propertyupdate tree, in document order:
[:set element] and [:remove name]. It's nil when the tree isn't a
propertyupdate.
The operations of the DAV:propertyupdate `tree`, in document order: [:set element] and [:remove name]. It's nil when the tree isn't a propertyupdate.
(read-propfind tree)The request of the DAV:propfind tree, as propfind takes it, with
:allprop? true for allprop. It's nil when the tree isn't a propfind of
prop, propname or allprop.
The request of the DAV:propfind `tree`, as propfind takes it, with :allprop? true for allprop. It's nil when the tree isn't a propfind of prop, propname or allprop.
The reason phrase of each status that WebDAV uses, by RFC 9110 and RFC 4918, section 11.
The reason phrase of each status that WebDAV uses, by RFC 9110 and RFC 4918, section 11.
(status-line status)The status line of the status, e.g. HTTP/1.1 404 Not Found.
The status line of the `status`, e.g. HTTP/1.1 404 Not Found.
(value element)The value of the property element: its text when it holds only text,
its children as Hiccup when it holds an element, or nil when it's
empty.
The value of the property `element`: its text when it holds only text, its children as Hiccup when it holds an element, or nil when it's empty.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |