Skip to main content

Module document

Module document 

Source
Expand description

The document hand-off’s types: what a hand-off names, and what a read answers with.

Type-only - the read that produces a DocumentRead lives in forge_agent::env::documents. The kind crosses every layer (the read detects it, the wire carries it, a viewer draws it), so it lives here per the crate placement guide; the resolved path, bytes and reviewable flag ride beside it rather than as separate parameters everywhere.

Re-exports§

use std::path::PathBuf; 🔒
use serde::Deserialize; 🔒
use serde::Deserialize; 🔒
use serde::Serialize; 🔒
use serde::Serialize; 🔒

Structs§

DocumentHandOffAsk
A parked hand-off as the read surface carries it: the id an answer names, the resolved path the viewer opens at, and the reviewable flag.
DocumentRead
One document, as the read answered: the path it resolved to, the bytes, the detected kind, and whether the DOCUMENT can carry a review - the hand-off’s commentable set, by extension.

Enums§

DocumentHandOffEnding
How a document hand-off ended, as the reader’s answer and the parked call’s release.
DocumentKind
What a document is, as far as the read can tell - by extension, not by sniffing the bytes.