Liking cljdoc? Tell your friends :D

mirthsync.files


assert-file-nameclj

(assert-file-name name)

Asserts that name is a single path component that can't refer to a parent or the current directory, and returns it unchanged.

Asserts that name is a single path component that can't refer to a parent or
the current directory, and returns it unchanged.
raw docstring

only-named-xml-files-seqclj

(only-named-xml-files-seq depth name dir)

Sequence of named xml files contained within directories in the target dir and subdirectories up to depth.

Sequence of named xml files contained within directories in the
target dir and subdirectories up to depth.
raw docstring

remove-extensionclj

(remove-extension file-path)

restrict-matcherclj

(restrict-matcher target restrict-to-path exact?)

Predicate over file path strings for --restrict-to-path.

exact? (see restrict-names-item?) true: only the named item and what is under it match, so restricting to channel ADT does not also take ADT Inbound, and group Lab does not take group Lab Archive. exact? false: the path is a partial name and keeps the original string-prefix match, so Channels/Default Group/AD still takes every channel in that group whose name starts with AD. An empty path matches everything under the target.

restrict-names-item? looks at the disk as well as the candidates, so a group and its channels agree about what Channels/Lab means.

Predicate over file path strings for --restrict-to-path.

exact? (see restrict-names-item?) true: only the named item and what is
under it match, so restricting to channel `ADT` does not also take
`ADT Inbound`, and group `Lab` does not take group `Lab Archive`.
exact? false: the path is a partial name and keeps the original
string-prefix match, so `Channels/Default Group/AD` still takes every
channel in that group whose name starts with AD. An empty path matches
everything under the target.

restrict-names-item? looks at the disk as well as the candidates, so a
group and its channels agree about what `Channels/Lab` means.
raw docstring

restrict-names-item?clj

(restrict-names-item? target restrict-to-path candidate-paths)

True when --restrict-to-path names an item exactly: one of candidate-paths is that item, or it exists on disk under target as a file, a directory or <path>.xml.

True when --restrict-to-path names an item exactly: one of
candidate-paths is that item, or it exists on disk under target as a
file, a directory or <path>.xml.
raw docstring

safe-nameclj

(safe-name name)

Asserts that the string param is creatable file that doesn't span paths. Fails with an exception if any issues are detected, otherwise returns the unmodified string (unless there are weird characters as defined in encode-path-chars and encode-windows-chars, a Windows reserved name, or a name too long for shorten-long-name; in which case the string is modified accordingly).

Asserts that the string param is creatable file that doesn't span paths. Fails
with an exception if any issues are detected, otherwise returns the unmodified
string (unless there are weird characters as defined in encode-path-chars and
encode-windows-chars, a Windows reserved name, or a name too long for
shorten-long-name; in which case the string is modified accordingly).
raw docstring

without-named-xml-files-seqclj

(without-named-xml-files-seq depth name dir)

Sequence of named xml files contained within directories in the target dir and subdirectories up to depth.

Sequence of named xml files contained within directories in the
target dir and subdirectories up to depth.
raw docstring

xml-file-seqclj

(xml-file-seq depth dir)

Xml file sequence at dir up to depth.

Xml file sequence at dir up to depth.
raw 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