Struct Document 

pub struct Document {
    source: Box<str>,
    arena: Arena,
    diagnostic_policy: DiagnosticPolicy,
}

Single owning handle to a parsed Aozora source.

Owns both the source buffer and a bumpalo-backed Arena. The &self lifetime parameterises every borrowed-AST view returned from Document::parse; consumers hold the tree only as long as they hold a &Document reference.

Fields

source: Box<str>

arena: Arena

diagnostic_policy: DiagnosticPolicy

Implementations

impl Document

pub fn new(source: impl Into<Box<str>>) -> Self

Wrap a source string in a Document with default options. Equivalent to ParseOptions::new().build(source).

The arena is pre-sized to source.len() * ARENA_CAPACITY_FACTOR bytes (a corpus-profile-driven estimate of the AST footprint: p50 arena/source ratio is 3.4×, p99 is 8.25×). Pre-sizing eliminates the early chunk-grow churn that hits large docs hardest. Callers that want to override the arena hint or diagnostic policy reach for Document::options / ParseOptions::build instead.

pub fn options() -> ParseOptions

Construct a fresh ParseOptions for the builder chain. Document::options().arena_capacity(N).diagnostic_policy(P).build(s) is the canonical configuration entry point.

pub fn with_arena_capacity( source: impl Into<Box<str>>, capacity_hint: usize, ) -> Self

👎Deprecated since 0.3.0: use Document::options().arena_capacity(n).build(source)

Wrap a source string with a pre-sized arena.

Document::options().arena_capacity(n).build(source) is the preferred path since the builder composes naturally with the diagnostic policy; this constructor remains for source-level compatibility with pre-Phase-I callers.

pub fn source(&self) -> &str

The source text owned by this document.

pub fn arena_bytes(&self) -> usize

Arena bytes currently committed. Diagnostic / benchmarking only.

pub fn edit(&self, span: Span, replacement: &str) -> Self

Apply an in-place text edit and return a fresh Document.

span is a byte range in the current source (self.source); replacement is the new text to splice in. The result is a new Document whose source equals self.source[..span.start] + replacement + self.source[span.end..]. The arena is rebuilt — incremental re-parse over the unchanged region is a future improvement (see the architecture handbook chapter on incremental parse).

The signature is the supported entry point for editor surfaces implementing textDocument/didChange. Even with a full reparse inside, callers get a stable API today and a transparent upgrade path to subtree-aware reuse later.

Panics

Panics if span.start > span.end, if span.end > source.len(), or if span.start / span.end does not lie on a UTF-8 codepoint boundary in self.source. These are programmer errors — editor integrations should clamp the span via the existing aozora::Span constructor’s bounds checking.

pub fn parse(&self) -> AozoraTree<'_>

Parse the document, returning a borrowed-AST view bound to &self’s lifetime.

Trait Implementations

impl Debug for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.