Liking cljdoc? Tell your friends :D

szew.fi.entry

Files into index entries.

Files into index entries.
raw docstring

entryclj

(entry)
(entry spec)

Entry be like:

{:top-path String | File :tag String :hash-bytes positive integer | :full | :skip :store-up-to positive integer | :full | :skip :encoding String}

The top-path will be removed from CanonicalPath of file and field calculated this way will be used for tag vs tag comparison in the db (relative path).

Initially this is only planned for small (<16KiB) files so we are also trying to capture contents of said files (as text!) and SHA-256 to that size limit. You can parametrize both settings separately, but please be vary of using :full on uncertain inputs. It really works best for wee files.

Entry be like:

  {:top-path    String | File
   :tag         String
   :hash-bytes  positive integer | :full | :skip
   :store-up-to positive integer | :full | :skip
   :encoding    String}

The top-path will be removed from CanonicalPath of file and field calculated
this way will be used for tag vs tag comparison in the db (relative path).

Initially this is only planned for small (<16KiB) files so we are also trying
to capture contents of said files (as text!) and SHA-256 to that size limit.
You can parametrize both settings separately, but please be vary of using
:full on uncertain inputs. It really works best for wee files.
raw docstring

Entryclj


gatherclj

(gather entry-point)
(gather entry-point process?)
(gather entry-point follow? process?)

Top entry, pruning and reading preds in. Seq of entries out.

Top entry, pruning and reading preds in. Seq of entries out.
raw docstring

of-interest?clj

(of-interest? file)

a-file -> bool

Simplest criteria: is it a file, can we read it.

a-file -> bool

Simplest criteria: is it a file, can we read it.
raw docstring

tag-topclj

(tag-top tag top-path)
(tag-top tag top-path opts)

Create entry with given tag and top-path. Use opts map for other fields.

Create entry with given tag and top-path. Use opts map for other fields.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close