ISource over a local rsync mirror of the RFC series.
Bulk access to the series is rsync, not HTTP: rsync -avz --delete rsync.rfc-editor.org::rfcs-text-only <dir>
Only the transport differs from the web source — the same rule chain, the same RfcTextParser and the same Document shape are reused through web-docs/body->document, and :document/source is the canonical rfc-editor URL, so document ids and cross-document KG edges agree with anything ingested over HTTP.
The series is ~10k files; a run is a WINDOW over it (:from, :to, :offset, :limit). Re-running a window is an upsert, not a duplicate, because chunk and document ids are derived from the source URL — that is the resumable story: crash, re-run the window, continue.
ISource over a local rsync mirror of the RFC series. Bulk access to the series is rsync, not HTTP: rsync -avz --delete rsync.rfc-editor.org::rfcs-text-only <dir> Only the transport differs from the web source — the same rule chain, the same RfcTextParser and the same Document shape are reused through web-docs/body->document, and :document/source is the canonical rfc-editor URL, so document ids and cross-document KG edges agree with anything ingested over HTTP. The series is ~10k files; a run is a WINDOW over it (:from, :to, :offset, :limit). Re-running a window is an upsert, not a duplicate, because chunk and document ids are derived from the source URL — that is the resumable story: crash, re-run the window, continue.
(canonical-url number)The rfc-editor URL an ingested mirror file is attributed to.
The rfc-editor URL an ingested mirror file is attributed to.
Mirror files that are RFC documents. The mirror also carries indices, errata and per-series symlinks, which are not documents.
Mirror files that are RFC documents. The mirror also carries indices, errata and per-series symlinks, which are not documents.
(mirror-entries dir {:keys [glob] :as opts})Every RFC document in the mirror at DIR as {:path :rfc/number :url}. Returns Result<vector>.
Every RFC document in the mirror at DIR as {:path :rfc/number :url}.
Returns Result<vector>.(mirror-files dir glob)Absolute paths of the regular files under DIR whose DIR-relative path matches GLOB, sorted. Returns Result<vector<string>>; a missing or non-directory DIR is an error, not an empty mirror.
Absolute paths of the regular files under DIR whose DIR-relative path matches GLOB, sorted. Returns Result<vector<string>>; a missing or non-directory DIR is an error, not an empty mirror.
(rfc-mirror-source dir)Create an RfcMirrorSource over a local rsync mirror directory.
Create an RfcMirrorSource over a local rsync mirror directory.
(rfc-number path)The RFC number a mirror file name denotes, or nil.
Only bare rfcN.txt qualifies: the mirror also holds rfcN-errata.txt and similarly shaped files that are not the document itself.
The RFC number a mirror file name denotes, or nil. Only bare rfcN.txt qualifies: the mirror also holds rfcN-errata.txt and similarly shaped files that are not the document itself.
(window entries {:keys [from to offset limit]})The mirror entries selected by OPTS, in ascending RFC order.
:from — lowest RFC number, inclusive :to — highest RFC number, inclusive :offset — entries to skip after filtering :limit — maximum entries to return
The mirror entries selected by OPTS, in ascending RFC order. :from — lowest RFC number, inclusive :to — highest RFC number, inclusive :offset — entries to skip after filtering :limit — maximum entries to return
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 |