docs.phext.io
LATEST REFERENCE
Reference as of head commit 9bcc011873c3965ac1cb3306350c007fe5a6c72d · 16 commits audited · chain sha256 ce21be227a735841…

phextura — project documentation

Scanned by phdoc 0.1.0 on 2026-11-22 (Exocortical Epoch 95). Project root: /home/wbic16/phdoc-sweep/proj/phextura/. Scanned at commit 9bcc011873c3965ac1cb3306350c007fe5a6c72d. Every fact in this document was read from its own records: its manifests, its git log, and its source text. Nothing here was guessed.

This document holds: what the project depends on, who wrote it, how large and how complex it is, the state of its quality signals, the RFCs it declares, where its upstream repo lives, and a plain English note for every public method and command.


Dependencies

Rust (cargo) — Cargo.toml

Direct dependencies: 1.

Total packages in the lock file, this one included: 3.


Authors

The git log holds 16 commits.

The author of record is Will Bickford — 16 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):


Complexity

The measure is stated plainly, and no single score is made: lines are counted per file as total lines, blank lines, comment lines, and code lines (total minus blank minus comment). Functions are counted where the scanner reads them, and the largest functions are given by their span in lines.

All languages: 17 files, 4898 lines total, 4033 lines of code. Functions read: 12.

Largest files:

Largest functions, by span in lines:


Code quality signals

Each signal is named and shown with its evidence. A signal is a fact the scanner read, not a grade.


Declared RFCs

No rfcs.json was found in this project, so it declares no RFCs. This is a finding, not an error: the project has not made an RFC declaration.


Upstream git repo


Public methods and commands

Every public method and command the scanner found, each with a plain English note. A note says where its words came from: the code's own doc comment, the item's signature, the user's agent, or it is marked awaiting a summary.


struct — Entry

Found in src/bibliography.rs at line 14.

Signature: pub struct Entry {

What it does: One bibliography entry, parsed from its scroll.

(Where these words came from: doc comment.)


function — Entry::field

Found in src/bibliography.rs at line 23.

Signature: pub fn field(&self, name: &str) -> Option<&str> {

What it does: Look up a field by name (author, title, year, …).

(Where these words came from: doc comment.)


function — parse

Found in src/bibliography.rs at line 31.

Signature: pub fn parse(coordinate: Coordinate, scroll: &str) -> Entry {

What it does: Parse an entry from its scroll text at coordinate.

(Where these words came from: doc comment.)


function — duplicate_candidates

Found in src/bibliography.rs at line 42.

Signature: pub fn duplicate_candidates(entries: &[Entry]) -> Vec<(Coordinate, Coordinate)> {

What it does: Group likely-duplicate entries for an author's review. Intended mechanism: libphext::phext::soundex_v1 on author names as a candidate generator only — a phonetic match is a hint for a human, never proof that two entries are the same work.

(Where these words came from: doc comment.)


const — BODY

Found in src/document.rs at line 14.

Signature: pub const BODY: usize = 1;

What it does: Chapters, sections, and content blocks.

(Where these words came from: doc comment.)


const — BIBLIOGRAPHY

Found in src/document.rs at line 16.

Signature: pub const BIBLIOGRAPHY: usize = 2;

What it does: One bibliography entry per scroll.

(Where these words came from: doc comment.)


const — MEDIA

Found in src/document.rs at line 18.

Signature: pub const MEDIA: usize = 3;

What it does: Figures and embedded media payloads.

(Where these words came from: doc comment.)


const — STYLES

Found in src/document.rs at line 20.

Signature: pub const STYLES: usize = 4;

What it does: Style scrolls.

(Where these words came from: doc comment.)


const — SUPPLEMENTS

Found in src/document.rs at line 22.

Signature: pub const SUPPLEMENTS: usize = 5;

What it does: Embedded documents: data, code, extended proofs.

(Where these words came from: doc comment.)


const — METADATA

Found in src/document.rs at line 24.

Signature: pub const METADATA: usize = 6;

What it does: Title, authors, abstract, provenance, checksum manifest.

(Where these words came from: doc comment.)


struct — Paper

Found in src/document.rs at line 28.

Signature: pub struct Paper {

What it does: A phextura paper: the corpus text and the coordinate of its root.

(Where these words came from: doc comment.)


function — Paper::new

Found in src/document.rs at line 39.

Signature: pub fn new(root: Coordinate) -> Paper {

What it does: Create an empty paper rooted at root. Intended behavior: seed the metadata subspace and an empty body.

(Where these words came from: doc comment.)


function — load

Found in src/document.rs at line 48.

Signature: pub fn load(corpus: &str) -> Paper {

What it does: Load a paper from imploded phext text (libphext::phext::explode is the intended mechanism for working with its scrolls).

(Where these words came from: doc comment.)


function — fetch

Found in src/document.rs at line 55.

Signature: pub fn fetch(&self, coord: Coordinate) -> String {

What it does: Fetch one scroll of the paper by coordinate (libphext::phext::fetch is the intended mechanism).

(Where these words came from: doc comment.)


enum — PayloadEncoding

Found in src/media.rs at line 16.

Signature: pub enum PayloadEncoding {

What it does: How a payload's bytes are carried as scroll text.

(Where these words came from: doc comment.)


struct — MediaHeader

Found in src/media.rs at line 27.

Signature: pub struct MediaHeader {

What it does: The header of an embedded media item: one scroll in the media division, preceding the payload scrolls it describes.

(Where these words came from: doc comment.)


function — verify

Found in src/media.rs at line 42.

Signature: pub fn verify(header: &MediaHeader, payload_text: &str) -> bool {

What it does: Verify a payload against its header checksum before rendering.

(Where these words came from: doc comment.)


struct — Reference

Found in src/reference.rs at line 14.

Signature: pub struct Reference {

What it does: A typed cross-reference: the coordinate of the scroll it points at.

(Where these words came from: doc comment.)


function — Reference::parse

Found in src/reference.rs at line 25.

Signature: pub fn parse(text: &str) -> Result<Reference, PhextParseError> {

What it does: Parse a reference from its written form in prose. Delegates to Coordinate's TryFrom impl, so malformed addresses surface as [PhextParseError] — a lint error, not a panic (the 0.5.0 behavior; 0.4.1 panicked here).

(Where these words came from: doc comment.)


struct — DanglingReference

Found in src/reference.rs at line 35.

Signature: pub struct DanglingReference {

What it does: One dangling reference found by validation: where it is written, and the coordinate it fails to reach.

(Where these words came from: doc comment.)


function — validate

Found in src/reference.rs at line 46.

Signature: pub fn validate(corpus: &str) -> Vec<DanglingReference> {

What it does: Validate every reference in a corpus in one pass. Intended mechanism: build the reference graph with libphext::phext::navmap, then fetch each target.

(Where these words came from: doc comment.)


function — render_html

Found in src/render.rs at line 17.

Signature: pub fn render_html(paper: &Paper) -> String {

What it does: Render a paper to HTML.

(Where these words came from: doc comment.)


function — render_print

Found in src/render.rs at line 24.

Signature: pub fn render_print(paper: &Paper) -> Vec<u8> {

What it does: Render a paper to a print-oriented backend (future work; the layout engine is deliberately unspecified in DESIGN.md §10).

(Where these words came from: doc comment.)


struct — StyleSheet

Found in src/style.rs at line 15.

Signature: pub struct StyleSheet {

What it does: A style sheet: the scroll that declares it, and its declarations.

(Where these words came from: doc comment.)


struct — StyleAssignment

Found in src/style.rs at line 25.

Signature: pub struct StyleAssignment {

What it does: Which style governs a subspace of a paper.

(Where these words came from: doc comment.)


function — parse

Found in src/style.rs at line 33.

Signature: pub fn parse(coordinate: Coordinate, scroll: &str) -> StyleSheet {

What it does: Parse a style scroll into a [StyleSheet].

(Where these words came from: doc comment.)


Provenance

This documentation is produced for the export repo wbic16/phdoc (its chain of record lives at docs/phextura/chain.phext) and for the doc site https://docs.phext.io. Both targets are the project's own configuration, held in its .phdoc.json as "export-repo" and "doc-site"; when a project does not name them, the defaults are wbic16/phdoc and https://docs.phext.io.

Historical reference · chain.phext · latest.md