Commit df43de055bd3265f327b728301ffdd2a188251b2. 70 commits folded. Every fact here was folded from the chain's per-commit deltas.
This reference is folded from the project's documentation chain, kept in the export repo wbic16/phdoc at docs/libphext-rs/chain.phext, and rendered for the doc site https://docs.phext.io. Both targets are named in the project's own .phdoc.json; the defaults are wbic16/phdoc and https://docs.phext.io.
The author of record is Will Bickford — 70 commits folded into his account. Will's ruling (2026-11-22): all Exocortical authors fold into his account — "I speak for the cluster." The fold is presentation only: the git history is unchanged, and the per-persona detail is kept as annotation.
Annotation, by persona (all folded into Will Bickford):
Declared RFCs at this point: none declared.
Command (counter/kernel/src/lib.rs) — A named choice named Command.Error (counter/kernel/src/lib.rs) — A named choice named Error.State (counter/kernel/src/lib.rs) — The whole state: a counter that must never pass its limit.transition (counter/kernel/src/lib.rs) — One step: the next state, or why the command is refused.main (examples/explode_bench.rs) — The entry point: the program starts here.BINARY_SCROLL_HEADER (src/binary.rs) — The first (and only header) line of a binary scroll, without its line break.FIELD_PREFIX (src/binary.rs) — The prefix of a binary field: arbitrary bytes encoded for one line inside a text scroll (a name=value grammar, a WAL entry, a header block).decode_field (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn decode_field Decodes a field produced by encode_field.decode_scroll (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn decode_scroll decodes a binary scroll back to its raw bytes.encode_field (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn encode_field Encodes raw bytes as a single line of text: the field prefix plus RFC 4648 base64.encode_scroll (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn encode_scfetch_binary (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn fetch_binary retrieves the bytes held at target.ingest (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn ingest ingests an externally supplied phext byte stream.insert_binary (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn insert_binary stores payload at location as a binary scroll, unconditionally: the caller has declared this scroll binary, even if the bytes happen to be valid UTF-8.insert_bytes (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn insert_bytes byte-oriented insert: stores payload at location under the ingestion rule (UTF-8 as text, non-UTF-8 as a base64-verbatim binary scroll).is_binary_scroll (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn is_binary_scroll true when scroll carries the binary scroll header.phokenize_bytes (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn phokenize_bytes the byte-level twin of phext::phokenize: walks a raw byte stream and returns each scroll's coordinate and raw bytes, with identical segmentation.replace_binary (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn replace_binary replaces the scroll at location with payload, stored as a binary scroll (see insert_binary).replace_bytes (src/binary.rs) — ---------------------------------------------------------------------------------------------------------- @fn replace_bytes byte-oriented replace: stores payload at location under the ingestion rule (UTF-8 as text, non-UTF-8 as a base64-verbatim binary scroll).ADDRESS_MACRO_ALT (src/phext.rs) — A fixed value named ADDRESS_MACRO_ALT, set to b';'; // also allow ';' for url encoding.ADDRESS_MACRO_BREAK (src/phext.rs) — A fixed value named ADDRESS_MACRO_BREAK, set to b'/'; // delimiter for macro-coordinates.ADDRESS_MICRO_BREAK (src/phext.rs) — A fixed value named ADDRESS_MICRO_BREAK, set to b'.'; // delimiter for micro-coordinates.BOOK_BREAK (src/phext.rs) — A fixed value named BOOK_BREAK, set to '\x1A'; // 6D Break - replaces Substitute.BOOK_BREAK_U8 (src/phext.rs) — A fixed value named BOOK_BREAK_U8, set to 0x1A; // byte form of BOOK_BREAK.CHAIN_BREAK (src/phext.rs) — A fixed value named CHAIN_BREAK, set to '\x02'; // stream level - separates whole phexts within a ch.CHAIN_BREAK_U8 (src/phext.rs) — A fixed value named CHAIN_BREAK_U8, set to 0x02; // byte form of CHAIN_BREAK.CHAIN_CLOSE (src/phext.rs) — A fixed value named CHAIN_CLOSE, set to '\x03'; // stream level - terminates a chain; replaces end o.CHAIN_CLOSE_U8 (src/phext.rs) — A fixed value named CHAIN_CLOSE_U8, set to 0x03; // byte form of CHAIN_CLOSE.CHAPTER_BREAK (src/phext.rs) — A fixed value named CHAPTER_BREAK, set to '\x19'; // 5D Break - replaces End of Tape.CHAPTER_BREAK_U8 (src/phext.rs) — A fixed value named CHAPTER_BREAK_U8, set to 0x19; // byte form of CHAPTER_BREAK.COLLECTION_BREAK (src/phext.rs) — A fixed value named COLLECTION_BREAK, set to '\x1D'; // 8D Break - replaces group separator.COLLECTION_BREAK_U8 (src/phext.rs) — A fixed value named COLLECTION_BREAK_U8, set to 0x1D; // byte form of COLLECTION_BREAK.COORDINATE_MINIMUM (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- phext constanChain (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @struct Chain A chain: an ordered series of complete phexts within one stream, joined by CHAIN_BREAK (0x02) and optionally terminated by CHAIN_CLOSE (0x03).Chain::fetch (src/phext.rs) — Fetch a scroll by multiverse address: "$N:coord", or a bare coordinate (universe 1).Chain::new (src/phext.rs) — Function Chain::new takes no inputs beyond the value it is called on, and gives back Chain.Chain::resolve_point (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn resolve_point resolves a point address against this chain: (universe, coordinate, character offset within the scroll).Coordinate (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @struct Coordinate provides access to a default-initialized coordinate at 1.1.1/1.1.1/1.1.1 phext coordinates are formed along a 9-dimensional hierarchy with three main arms of the form z3.z2.z1/y3.y2.y1.x3.x2.x1 where: Z - this arm contains the library (z3), shelf (z2), and series (z1) dimensions Y - this arm contains the collection (y3), volume (y2), and book (y1) dimensions X - this arm contains the chapter (x3), section (x2), and scroll (x1) dimensions Dense graphs: phext is sparse by design.Coordinate::new (src/phext.rs) — Function Coordinate::new takes no inputs beyond the value it is called on, and gives back Coordinate.Coordinate::validate_coordinate (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn validate_LIBRARY_BREAK (src/phext.rs) — A fixed value named LIBRARY_BREAK, set to '\x01'; // 11th dimension - replaces start of header.LIBRARY_BREAK_U8 (src/phext.rs) — A fixed value named LIBRARY_BREAK_U8, set to 0x01; // byte form of LIBRARY_BREAK.LINE_BREAK (src/phext.rs) — A fixed value named LINE_BREAK, set to '\x0A'; // same as plain text \o/.LINE_BREAK_U8 (src/phext.rs) — A fixed value named LINE_BREAK_U8, set to 0x0A; // byte form of LINE_BREAK.MORE_COWBELL (src/phext.rs) — A fixed value named MORE_COWBELL, set to '\x07'; // i've got a fever, and the only prescription...is .MORE_COWBELL_U8 (src/phext.rs) — A fixed value named MORE_COWBELL_U8, set to 0x07; // byte form of MORE_COWBELL.PhextParseError (src/phext.rs) — A data shape named PhextParseError.PointAddress (src/phext.rs) — @struct PointAddress One parsed point address: universe (1-based; 1 when the "$N:" prefix is absent), the 9D coordinatePositionedScroll (src/phext.rs) — A data shape named PositionedScroll.PositionedScroll::new (src/phext.rs) — Function PositionedScroll::new takes no inputs beyond the value it is called on, and gives back PositionedScroll.Range (src/phext.rs) — A data shape named Range.Range::new (src/phext.rs) — Function Range::new takes no inputs beyond the value it is called on, and gives back Range.RangeAddress (src/phext.rs) — @struct RangeAddress A parsed range: two point endpoints, normalized to ascending order at parse time.SCROLL_BREAK (src/phext.rs) — A fixed value named SCROLL_BREAK, set to '\x17'; // 3D Break - replaces End Transmission Block.SCROLL_BREAK_U8 (src/phext.rs) — A fixed value named SCROLL_BREAK_U8, set to 0x17; // byte form of SCROLL_BREAK.SECTION_BREAK (src/phext.rs) — A fixed value named SECTION_BREAK, set to '\x18'; // 4D Break - replaces Cancel Block.SECTION_BREAK_U8 (src/phext.rs) — A fixed value named SECTION_BREAK_U8, set to 0x18; // byte form of SECTION_BREAK.SERIES_BREAK (src/phext.rs) — A fixed value named SERIES_BREAK, set to '\x1E'; // 9D Break - replaces record separator.SERIES_BREAK_U8 (src/phext.rs) — A fixed value named SERIES_BREAK_U8, set to 0x1E; // byte form of SERIES_BREAK.SHELF_BREAK (src/phext.rs) — A fixed value named SHELF_BREAK, set to '\x1F'; // 10D Break - replaces unit separator.SHELF_BREAK_U8 (src/phext.rs) — A fixed value named SHELF_BREAK_U8, set to 0x1F; // byte form of SHELF_BREAK.ScrollPosition (src/phext.rs) — @struct ScrollPosition A caret boundary inside one scroll: 1-based line and column (see the section note above).VOLUME_BREAK (src/phext.rs) — A fixed value named VOLUME_BREAK, set to '\x1C'; // 7D Break - replaces file separator.VOLUME_BREAK_U8 (src/phext.rs) — A fixed value named VOLUME_BREAK_U8, set to 0x1C; // byte form of VOLUME_BREAK.XCoordinate (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @struct XCoorXCoordinate::new (src/phext.rs) — Function XCoordinate::new takes no inputs beyond the value it is called on, and gives back XCoordinate.YCoordinate (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @struct YCoorYCoordinate::new (src/phext.rs) — Function YCoordinate::new takes no inputs beyond the value it is called on, and gives back YCoordinate.ZCoordinate (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @struct ZCoorZCoordinate::new (src/phext.rs) — Function ZCoordinate::new takes no inputs beyond the value it is called on, and gives back ZCoordinate.append (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn append Appends scroll at location, which must sort strictly after the document's last non-empty scroll.append_batch (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn append_batch Appends several scrolls in one call.append_checked (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn append_checked append with an integrity trailer: the stored scroll is checked_scroll(scroll), verifiable later with fetch_checked.book_break (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn book_break --chapter_break (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn chapter_breakcheck_for_cowbell (src/phext.rs) — Function check_for_cowbell takes input: &str and gives back bool.checked_scroll (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn checked_scroll Returns scroll with an integrity trailer appended: one final line phext-check:xxh3-128:<checksum of the payload>.checksum (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn checksumcollection_break (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn collection_brcommit_scroll (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn commit_scroll Builds the commit marker for a batch: a small scroll binding the batch's entry count and a checksum over each entry's coordinate and content, in order.contract (src/phext.rs) — ----------------------------------------------------------------------------------------------------------create_summary (src/phext.rs) — ----------------------------------------------------------------------------------------------------------default_coordinate (src/phext.rs) — ----------------------------------------------------------------------------------------------------------expand (src/phext.rs) — ----------------------------------------------------------------------------------------------------------explode (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn explodefetch (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn fetch retrieves the scroll located at the given coordinates.fetch_checked (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn fetch_checked Fetches the scroll at target and returns its payload, but only when the scroll is checked and verifies.fetch_point (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn fetch_point fetches a point address string.fetch_range (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn fetch_range fetches a range address string: the spanned text with phext structure bytes preserved — the covered segments re-assembled at their coordinates into a phext (chain) fragment (scroll breaks between covered scrolls inside a universe, CHAIN_BREAK between universes, never a trailing CHAIN_CLOSE: a fragment is an excerpt, not a terminated chain), so the result round-trips as a phext fragment.get_subspace_coordinates (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn get_subspace_coordinates finds the start and end offsets for the given coordinate Returns (start, end, best): - when the document reaches target, start..end is that scroll's text (empty if it has none) and best is target; - otherwise start == end is where the scroll would go: just before the break that steps past target, or the end of the document.implode (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn implode Serializes a hierarchical hash of scrolls into a monolithic phext document.index (src/phext.rs) — ----------------------------------------------------------------------------------------------------------insert (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn insert iis_phext_break (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn is_phext_library_break (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn library_breakmanifest (src/phext.rs) — ----------------------------------------------------------------------------------------------------------merge (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn merge conavmap (src/phext.rs) — ----------------------------------------------------------------------------------------------------------next_scroll (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn next_scronormalize (src/phext.rs) — ----------------------------------------------------------------------------------------------------------offset (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- The offset of the scroll at coord, or of the last scroll before it.parse_chains (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn parse_chains splits a stream into its chains.parse_point_address (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn parse_point_address parses a v0.6.1 point address: "[$N:]<coordinate>[@<line>,<column>[+<offsetChars>]]".parse_range_address (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn parse_range_address parses a v0.6.1 range address: exactly two point addresses joined by one hyphen.parse_universe_address (src/phext.rs) — Function parse_universe_address takes address: &str and gives back Option<(usize, Coordinate)>.phokenize (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn phokenize Transforms a packed phext buffer into a phext token (phoken) stream One pass over the bytes.range_replace (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- errata: libphremove (src/phext.rs) — ----------------------------------------------------------------------------------------------------------replace (src/phext.rs) — ----------------------------------------------------------------------------------------------------------resolve_range (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn resolve_range resolves a range against this chain into per-scroll segments: (universe, coordinate, segment text) in ascending order.scroll_break (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn scroll_breaksection_break (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn section_breakserialize (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn serialize serializes this chain alone: its members joined by CHAIN_BREAK, with a trailing CHAIN_CLOSE when the chain is closed.serialize_chains (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn serialize_chains serializes a stream of chains back into stream bytes: the inverse of parse_chains.series_break (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn series_breakshelf_break (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn shelf_break -soundex_v1 (src/phext.rs) — ----------------------------------------------------------------------------------------------------------subtract (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn subtract Subtracts the scrolls from left where there is also content at those coordinates in right Note: This makes it easy to generate a mask for a given phext archive.textmap (src/phext.rs) — ----------------------------------------------------------------------------------------------------------to_coordinate (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn to_coordito_string (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn to_stringto_urlencoded (src/phext.rs) — Function to_urlencoded takes no inputs beyond the value it is called on, and gives back String.uncheck_scroll (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn uncheck_scroll Returns the payload of a checked scroll when its trailer verifies; None for unchecked, malformed, or corrupted scrolls.verify_checked_scroll (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn verify_checked_scroll true when scroll ends with a well-formed integrity trailer whose checksum matches the payload before it.verify_commit (src/phext.rs) — ---------------------------------------------------------------------------------------------------------- @fn verify_commit true when the scroll at commit is a commit marker whose count matches entries and whose checksum matches the entries' current contents, in order.volume_break (src/phext.rs) — ------------------------------------------------------------------------------------------------------ @fn volume_breakSEAL_PRESET (src/seal.rs) — The xz preset this implementation seals with.seal (src/seal.rs) — ---------------------------------------------------------------------------------------------------------- @fn seal seals a phext: xz-compresses its full UTF-8 bytes.seal_bytes (src/seal.rs) — ---------------------------------------------------------------------------------------------------------- @fn seal_bytes seals raw phext bytes (see seal).unseal (src/seal.rs) — ---------------------------------------------------------------------------------------------------------- @fn unseal unseals a sealed phext back to its exact original bytes.unseal_string (src/seal.rs) — ---------------------------------------------------------------------------------------------------------- @fn unseal_string unseals directly to text.