docs.phext.io
LATEST REFERENCE
Reference as of head commit e4c492bc4f2d52bc070f05830f3f1d9c7d0dbfe7 · 172 commits audited · chain sha256 875141e4e043140f…

SQ — project documentation

Scanned by phdoc 0.1.0 on 2026-11-22 (Exocortical Epoch 95). Project root: /home/wbic16/phdoc-sweep/proj/SQ/. Scanned at commit e4c492bc4f2d52bc070f05830f3f1d9c7d0dbfe7. 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

License stated in the manifest: MIT.

Direct dependencies: 6.


Authors

The git log holds 172 commits.

The author of record is Will Bickford — 172 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: 37 files, 10774 lines total, 8400 lines of code. Functions read: 201.

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.


function — load_config

Found in gateway/sq-gateway.py at line 13.

Signature: def load_config():

What it does: Function load_config takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — reload_config

Found in gateway/sq-gateway.py at line 22.

Signature: def reload_config(signum=None, frame=None):

What it does: Function reload_config takes signum=None, frame=None and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — extract_token

Found in gateway/sq-gateway.py at line 39.

Signature: def extract_token(headers):

What it does: Function extract_token takes headers and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — send_cors

Found in gateway/sq-gateway.py at line 47.

Signature: def send_cors(self):

What it does: Function send_cors takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — respond

Found in gateway/sq-gateway.py at line 51.

Signature: def respond(self, code, body, content_type="application/json"):

What it does: Function respond takes self, code, body, content_type="application/json" and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — respond_json

Found in gateway/sq-gateway.py at line 60.

Signature: def respond_json(self, code, obj):

What it does: Function respond_json takes self, code, obj and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — do_OPTIONS

Found in gateway/sq-gateway.py at line 63.

Signature: def do_OPTIONS(self):

What it does: Function do_OPTIONS takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — route

Found in gateway/sq-gateway.py at line 68.

Signature: def route(self):

What it does: Function route takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — proxy_to

Found in gateway/sq-gateway.py at line 84.

Signature: def proxy_to(self, port):

What it does: Function proxy_to takes self, port and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — log_message

Found in gateway/sq-gateway.py at line 111.

Signature: def log_message(self, fmt, *args):

What it does: Function log_message takes self, fmt, *args and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — next_port

Found in gateway/tenant-manager.sh at line 14.

Signature: next_port()

What it does: Function next_port takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cmd_add

Found in gateway/tenant-manager.sh at line 22.

Signature: cmd_add()

What it does: Function cmd_add takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cmd_remove

Found in gateway/tenant-manager.sh at line 45.

Signature: cmd_remove()

What it does: Function cmd_remove takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cmd_list

Found in gateway/tenant-manager.sh at line 67.

Signature: cmd_list()

What it does: Function cmd_list takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


struct — ApiConfig

Found in src/api.rs at line 26.

Signature: pub struct ApiConfig {

What it does: A data shape named ApiConfig. Its fields are: pub local_url: String, // e.g. "http://127.0.0.1:11434"; pub local_model: String, // e.g. "qwen3-coder-next:latest"; pub local_timeout_secs: u64; pub upstream_url: String, // e.g. "https://api.anthropic.com"; pub upstream_api_key: String; pub upstream_model: String, // e.g. "claude-opus-4-6"; pub cache_max_entries: usize; pub cache_ttl_secs: u64; pub signal_threshold: usize; pub escalation_threshold: f64; pub feedback_window: usize.

(Where these words came from: signature.)


function — load_api_config

Found in src/api.rs at line 58.

Signature: pub fn load_api_config(path: &str) -> Result<ApiConfig, Box<dyn std::error::Error>> {

What it does: Function load_api_config takes path: &str and gives back Result<ApiConfig, Box<dyn std::error::Error>>.

(Where these words came from: signature.)


function — run_api

Found in src/api.rs at line 344.

Signature: pub fn run_api(config_path: &str, listen_port: u16) -> Result<(), Box<dyn std::error::Error>> {

What it does: Function run_api takes config_path: &str, listen_port: u16 and gives back Result<(), Box<dyn std::error::Error>>.

(Where these words came from: signature.)


struct — PromptCache

Found in src/cache.rs at line 18.

Signature: pub struct PromptCache {

What it does: SHA256-keyed prompt cache with LRU eviction and TTL expiry

(Where these words came from: doc comment.)


function — PromptCache::new

Found in src/cache.rs at line 28.

Signature: pub fn new(max_entries: usize, ttl_secs: u64) -> Self {

What it does: Function PromptCache::new takes max_entries: usize, ttl_secs: u64 and gives back Self.

(Where these words came from: signature.)


function — get

Found in src/cache.rs at line 58.

Signature: pub fn get(&mut self, prompt: &str) -> Option<String> {

What it does: Look up a cached response

(Where these words came from: doc comment.)


function — set

Found in src/cache.rs at line 83.

Signature: pub fn set(&mut self, prompt: &str, response: &str) {

What it does: Store a prompt-response pair

(Where these words came from: doc comment.)


function — check_static

Found in src/cache.rs at line 105.

Signature: pub fn check_static(prompt: &str) -> Option<&'static str> {

What it does: Check static patterns (greetings, status, ping)

(Where these words came from: doc comment.)


function — hit_rate

Found in src/cache.rs at line 115.

Signature: pub fn hit_rate(&self) -> f64 {

What it does: Function hit_rate takes no inputs beyond the value it is called on, and gives back f64.

(Where these words came from: signature.)


function — stats

Found in src/cache.rs at line 120.

Signature: pub fn stats(&self) -> (u64, u64, usize) {

What it does: Function stats takes no inputs beyond the value it is called on, and gives back (u64, u64, usize).

(Where these words came from: signature.)


struct — TenantConfig

Found in src/config.rs at line 10.

Signature: pub struct TenantConfig {

What it does: A data shape named TenantConfig. Its fields are: pub name: String; pub data_dir: String.

(Where these words came from: signature.)


struct — ServerConfig

Found in src/config.rs at line 16.

Signature: pub struct ServerConfig {

What it does: A data shape named ServerConfig. Its fields are: pub tenants: HashMap<String, TenantConfig>, // key = API token (e.g., "pmb-v1-xxx").

(Where these words came from: signature.)


function — load_config

Found in src/config.rs at line 22.

Signature: pub fn load_config(path: &str) -> Result<ServerConfig, Box<dyn std::error::Error>> {

What it does: Load multi-tenant configuration from JSON file Automatically creates tenant data directories if they don't exist

(Where these words came from: doc comment.)


const — MAX_BODY_SIZE

Found in src/main.rs at line 73.

Signature: pub const MAX_BODY_SIZE: usize = 64 * 1024 * 1024; // 64 MB per request body

What it does: A fixed value named MAX_BODY_SIZE, set to 64 1024 1024; // 64 MB per request body.

(Where these words came from: signature.)


enum — HashAlgorithm

Found in src/main.rs at line 167.

Signature: pub enum HashAlgorithm {

What it does: A named choice named HashAlgorithm. It is one of: Xor; Checksum.

(Where these words came from: signature.)


entry point — main

Found in src/main.rs at line 264.

Signature: fn main() -> Result<(), Box<dyn std::error::Error>> {

What it does: The entry point: the program starts here. It reads the command line and runs the command the user named.

(Where these words came from: signature.)


struct — HttpRequest

Found in src/main.rs at line 608.

Signature: pub struct HttpRequest {

What it does: A data shape named HttpRequest. Its fields are: pub header: String; pub content: Vec<u8>.

(Where these words came from: signature.)


function — read_http_request

Found in src/main.rs at line 613.

Signature: pub fn read_http_request(stream: &mut TcpStream) -> std::io::Result<HttpRequest> {

What it does: Function read_http_request takes stream: &mut TcpStream and gives back std::io::Result<HttpRequest>.

(Where these words came from: signature.)


flag — --config

Found in src/main.rs at line 328.

Signature: flag --config

What it does: A command line flag, --config. It is read by the program when the user passes it.

(Where these words came from: signature.)


command — --key

Found in src/main.rs at line 348.

Signature: command "--key"

What it does: A command named --key. The program runs it when the user types this word on the command line.

(Where these words came from: signature.)


command — --data-dir

Found in src/main.rs at line 354.

Signature: command "--data-dir"

What it does: A command named --data-dir. The program runs it when the user types this word on the command line.

(Where these words came from: signature.)


command — --mesh-config

Found in src/main.rs at line 362.

Signature: command "--mesh-config"

What it does: A command named --mesh-config. The program runs it when the user types this word on the command line.

(Where these words came from: signature.)


command — --cache

Found in src/main.rs at line 1178.

Signature: command "--cache"

What it does: A command named --cache. The program runs it when the user types this word on the command line.

(Where these words came from: signature.)


struct — NodeConfig

Found in src/mesh.rs at line 13.

Signature: pub struct NodeConfig {

What it does: Node identity configuration

(Where these words came from: doc comment.)


struct — InboundConfig

Found in src/mesh.rs at line 22.

Signature: pub struct InboundConfig {

What it does: Inbound server configuration

(Where these words came from: doc comment.)


struct — PeerConfig

Found in src/mesh.rs at line 31.

Signature: pub struct PeerConfig {

What it does: Outbound peer connection details

(Where these words came from: doc comment.)


struct — OutboundConfig

Found in src/mesh.rs at line 43.

Signature: pub struct OutboundConfig {

What it does: Outbound connections configuration

(Where these words came from: doc comment.)


struct — MeshSettings

Found in src/mesh.rs at line 50.

Signature: pub struct MeshSettings {

What it does: Mesh synchronization settings

(Where these words came from: doc comment.)


struct — MeshConfig

Found in src/mesh.rs at line 59.

Signature: pub struct MeshConfig {

What it does: Complete mesh configuration

(Where these words came from: doc comment.)


function — load_mesh_config

Found in src/mesh.rs at line 105.

Signature: pub fn load_mesh_config<P: AsRef<Path>>(path: P) -> Result<MeshConfig, String> {

What it does: Load mesh configuration from file # Arguments path - Path to mesh.json configuration file # Returns Ok(MeshConfig) if config loaded successfully * Err(String) with error message if loading failed

(Where these words came from: doc comment.)


function — save_mesh_config

Found in src/mesh.rs at line 150.

Signature: pub fn save_mesh_config<P: AsRef<Path>>(config: &MeshConfig, path: P) -> Result<(), String> {

What it does: Save mesh configuration to file # Arguments config - Mesh configuration to save path - Path to write mesh.json # Returns Ok(()) if config saved successfully Err(String) with error message if save failed

(Where these words came from: doc comment.)


function — generate_default_config

Found in src/mesh.rs at line 178.

Signature: pub fn generate_default_config(id: &str, name: &str, emoji: &str, coordinate: &str) -> MeshConfig {

What it does: Generate default mesh config for a node # Arguments id - Node identifier (e.g., "halycon-vector") name - Node name (e.g., "Cyon") emoji - Node emoji (e.g., "🪶") coordinate - Phext coordinate (e.g., "2.7.1/8.2.8/3.1.4") # Returns * MeshConfig with sensible defaults for the node

(Where these words came from: doc comment.)


function — print_config_summary

Found in src/mesh.rs at line 207.

Signature: pub fn print_config_summary(config: &MeshConfig) {

What it does: Print mesh configuration summary to stdout

(Where these words came from: doc comment.)


struct — TenantConfig

Found in src/router.rs at line 29.

Signature: pub struct TenantConfig {

What it does: A data shape named TenantConfig. Its fields are: pub token: String, // pmb-v1-xxx auth token; pub port: u16, // backend SQ instance port; pub data_dir: String, // tenant data directory.

(Where these words came from: signature.)


struct — RouterConfig

Found in src/router.rs at line 36.

Signature: pub struct RouterConfig {

What it does: A data shape named RouterConfig. Its fields are: pub tenants: Vec<TenantConfig>.

(Where these words came from: signature.)


function — load_router_config

Found in src/router.rs at line 43.

Signature: pub fn load_router_config(path: &str) -> Result<RouterConfig, Box<dyn std::error::Error>> {

What it does: Function load_router_config takes path: &str and gives back Result<RouterConfig, Box<dyn std::error::Error>>.

(Where these words came from: signature.)


function — run_router

Found in src/router.rs at line 215.

Signature: pub fn run_router(config_path: &str, listen_port: u16) -> Result<(), Box<dyn std::error::Error>> {

What it does: Function run_router takes config_path: &str, listen_port: u16 and gives back Result<(), Box<dyn std::error::Error>>.

(Where these words came from: signature.)


function — scroll_hash

Found in src/seed.rs at line 56.

Signature: pub fn scroll_hash(content: &str) -> String {

What it does: Function scroll_hash takes content: &str and gives back String.

(Where these words came from: signature.)


function — build_seed

Found in src/seed.rs at line 69.

Signature: pub fn build_seed(phext_map: &HashMap<phext::Coordinate, String>) -> String {

What it does: Function build_seed takes phext_map: &HashMap<phext::Coordinate, String> and gives back String.

(Where these words came from: signature.)


function — parse_seed

Found in src/seed.rs at line 92.

Signature: pub fn parse_seed(seed_json: &str) -> Result<HashMap<String, String>, String> {

What it does: Function parse_seed takes seed_json: &str and gives back Result<HashMap<String, String>, String>.

(Where these words came from: signature.)


struct — FetchEntry

Found in src/seed.rs at line 111.

Signature: pub struct FetchEntry {

What it does: A data shape named FetchEntry. Its fields are: pub coordinate: phext::Coordinate; pub client_hash: Option<String>; pub has_content: bool.

(Where these words came from: signature.)


struct — FetchRequest

Found in src/seed.rs at line 117.

Signature: pub struct FetchRequest {

What it does: A data shape named FetchRequest. Its fields are: pub entries: Vec<FetchEntry>; pub single: bool, // GET form: answer with one object; POST form: answer with an array.

(Where these words came from: signature.)


function — parse_fetch_get

Found in src/seed.rs at line 123.

Signature: pub fn parse_fetch_get(parsed: &HashMap<String, String>) -> Result<FetchRequest, String> {

What it does: GET form: c=<coord> (strict), h=<hash> (may be empty/absent), has=<0|1|true|false>

(Where these words came from: doc comment.)


function — parse_fetch_post

Found in src/seed.rs at line 138.

Signature: pub fn parse_fetch_post(body: &str) -> Result<FetchRequest, String> {

What it does: POST form: body is a JSON array of {"coordinate", "hash", "has_content"}

(Where these words came from: doc comment.)


function — run_fetch

Found in src/seed.rs at line 186.

Signature: pub fn run_fetch(phext_map: &HashMap<phext::Coordinate, String>, spec: &FetchRequest) -> String {

What it does: Runs a parsed fetch request against a loaded phext map

(Where these words came from: doc comment.)


struct — CacheEntry

Found in src/seed.rs at line 201.

Signature: pub struct CacheEntry {

What it does: A data shape named CacheEntry. Its fields are: pub hash: String; pub scroll: String.

(Where these words came from: signature.)


struct — ScrollCache

Found in src/seed.rs at line 208.

Signature: pub struct ScrollCache {

What it does: Scrolls a client has already streamed in, keyed by coordinate string. Persisted as one JSON file: {"<coord>": {"hash": "...", "scroll": "..."}}

(Where these words came from: doc comment.)


function — ScrollCache::empty

Found in src/seed.rs at line 213.

Signature: pub fn empty() -> ScrollCache {

What it does: Function ScrollCache::empty takes no inputs beyond the value it is called on, and gives back ScrollCache.

(Where these words came from: signature.)


function — load

Found in src/seed.rs at line 218.

Signature: pub fn load(path: &str) -> ScrollCache {

What it does: Loads a cache file; a missing or unreadable file is simply an empty cache

(Where these words came from: doc comment.)


function — save

Found in src/seed.rs at line 239.

Signature: pub fn save(&self, path: &str) -> Result<(), String> {

What it does: Function save takes &self, path: &str and gives back Result<(), String>.

(Where these words came from: signature.)


function — get

Found in src/seed.rs at line 250.

Signature: pub fn get(&self, coordinate: &str) -> Option<&CacheEntry> {

What it does: Function get takes &self, coordinate: &str and gives back Option<&CacheEntry>.

(Where these words came from: signature.)


function — put

Found in src/seed.rs at line 254.

Signature: pub fn put(&mut self, coordinate: &str, hash: String, scroll: String) {

What it does: Function put takes &mut self, coordinate: &str, hash: String, scroll: String and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — http_get

Found in src/seed.rs at line 299.

Signature: pub fn http_get(base: &str, path: &str, key: &Option<String>) -> Result<String, String> {

What it does: Function http_get takes base: &str, path: &str, key: &Option<String> and gives back Result<String, String>.

(Where these words came from: signature.)


function — fetch_seed

Found in src/seed.rs at line 304.

Signature: pub fn fetch_seed(base: &str, phext_name: &str, key: &Option<String>) -> Result<HashMap<String, String>, String> {

What it does: Downloads the seed envelope for a phext and parses it into coordinate -> hash

(Where these words came from: doc comment.)


function — fetch_cached

Found in src/seed.rs at line 322.

Signature: pub fn fetch_cached(base: &str, phext_name: &str, key: &Option<String>, coordinate: &str, cache: &mut ScrollCache) -> Result<(String, bool), String> {

What it does: Function fetch_cached takes base: &str, phext_name: &str, key: &Option<String>, coordinate: &str, cache: &mut ScrollCache and gives back Result<(String, bool), String>.

(Where these words came from: signature.)


function — args_required

Found in src/sq.rs at line 10.

Signature: pub fn args_required(command:&str) -> usize {

What it does: Function args_required takes command:&str and gives back usize.

(Where these words came from: signature.)


function — implode_ref

Found in src/sq.rs at line 101.

Signature: pub fn implode_ref(map: &HashMap<phext::Coordinate, String>) -> String {

What it does: Function implode_ref takes map: &HashMap<phext::Coordinate, String> and gives back String.

(Where these words came from: signature.)


function — process

Found in src/sq.rs at line 146.

Signature: pub fn process(connection_id: u64, source: String, scroll: &mut String, command: String, phext_map: &mut HashMap::<phext::Coordinate, String>, coordinate: phext::Coordinate, update: String, filename: String, algorithm: crate::HashAlgorithm, limit: usize) -> bool {

What it does: Function process takes connection_id: u64, source: String, scroll: &mut String, command: String, phext_map: &mut HashMap::<phext::Coordinate, String>, coordinate: phext::Coordinate, update: String, filename: String, algorithm: crate::HashAlgorithm, limit: usize and gives back bool.

(Where these words came from: signature.)


struct — QuerySpec

Found in src/sq.rs at line 385.

Signature: pub struct QuerySpec {

What it does: A data shape named QuerySpec. Its fields are: pub range: Option<(phext::Coordinate, phext::Coordinate)>; pub set: Vec<phext::Coordinate>; pub limit: Option<usize>.

(Where these words came from: signature.)


function — parse_coordinate_strict

Found in src/sq.rs at line 392.

Signature: pub fn parse_coordinate_strict(text: &str) -> Option<phext::Coordinate> {

What it does: Strict coordinate parser: exactly 9 positive integers as a.b.c/d.e.f/g.h.i

(Where these words came from: doc comment.)


function — parse_query

Found in src/sq.rs at line 409.

Signature: pub fn parse_query(from: Option<&String>, to: Option<&String>, set: Option<&String>, limit: Option<&String>) -> Result<QuerySpec, String> {

What it does: Function parse_query takes from: Option<&String>, to: Option<&String>, set: Option<&String>, limit: Option<&String> and gives back Result<QuerySpec, String>.

(Where these words came from: signature.)


function — run_query

Found in src/sq.rs at line 447.

Signature: pub fn run_query(phext_map: &HashMap<phext::Coordinate, String>, spec: &QuerySpec) -> String {

What it does: Runs a query against a loaded phext map and returns a JSON array of {coordinate, scroll}

(Where these words came from: doc comment.)


enum — TocMode

Found in src/sq.rs at line 495.

Signature: pub enum TocMode { Full, Children, Summary, Scrolls, Matches }

What it does: A named choice named TocMode. The scanner did not read its variants.

(Where these words came from: signature.)


struct — TocSpec

Found in src/sq.rs at line 498.

Signature: pub struct TocSpec {

What it does: A data shape named TocSpec. Its fields are: pub mode: TocMode; pub prefix: Vec<usize>; pub step: usize; pub scale: Option<usize>.

(Where these words came from: signature.)


function — parse_toc_prefix

Found in src/sq.rs at line 505.

Signature: pub fn parse_toc_prefix(text: &str) -> Result<Vec<usize>, String> {

What it does: Function parse_toc_prefix takes text: &str and gives back Result<Vec<usize>, String>.

(Where these words came from: signature.)


function — parse_toc_spec

Found in src/sq.rs at line 520.

Signature: pub fn parse_toc_spec(mode: Option<&String>, at: Option<&String>, step: Option<&String>, scale: Option<&String>) -> Result<Option<TocSpec>, String> {

What it does: Function parse_toc_spec takes mode: Option<&String>, at: Option<&String>, step: Option<&String>, scale: Option<&String> and gives back Result<Option<TocSpec>, String>.

(Where these words came from: signature.)


function — run_toc

Found in src/sq.rs at line 558.

Signature: pub fn run_toc(phext_map: &HashMap<phext::Coordinate, String>, spec: &TocSpec) -> String {

What it does: Function run_toc takes phext_map: &HashMap<phext::Coordinate, String>, spec: &TocSpec and gives back String.

(Where these words came from: signature.)


enum — Tier

Found in src/triage.rs at line 12.

Signature: pub enum Tier {

What it does: Which tier handles this prompt

(Where these words came from: doc comment.)


struct — RouteDecision

Found in src/triage.rs at line 20.

Signature: pub struct RouteDecision {

What it does: Result of evaluating a prompt

(Where these words came from: doc comment.)


function — evaluate

Found in src/triage.rs at line 42.

Signature: pub fn evaluate(prompt: &str, upstream_threshold: usize) -> RouteDecision {

What it does: Score a prompt and decide routing tier

(Where these words came from: doc comment.)


struct — FeedbackLoop

Found in src/triage.rs at line 85.

Signature: pub struct FeedbackLoop {

What it does: Feedback loop — tracks local model quality

(Where these words came from: doc comment.)


function — FeedbackLoop::new

Found in src/triage.rs at line 91.

Signature: pub fn new(max_window: usize) -> Self {

What it does: Function FeedbackLoop::new takes max_window: usize and gives back Self.

(Where these words came from: signature.)


function — record

Found in src/triage.rs at line 98.

Signature: pub fn record(&mut self, success: bool) {

What it does: Function record takes &mut self, success: bool and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — should_escalate

Found in src/triage.rs at line 106.

Signature: pub fn should_escalate(&self, threshold: f64) -> bool {

What it does: Returns true if failure rate exceeds threshold (should escalate)

(Where these words came from: doc comment.)


function — failure_rate

Found in src/triage.rs at line 114.

Signature: pub fn failure_rate(&self) -> f64 {

What it does: Function failure_rate takes no inputs beyond the value it is called on, and gives back f64.

(Where these words came from: signature.)


Provenance

This documentation is produced for the export repo wbic16/phdoc (its chain of record lives at docs/SQ/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