Struct ParsedDoc 

pub struct ParsedDoc {
    pub errors: Vec<ParseError>,
    /* private fields */
}

Owns a parsed PHP document: the bumpalo arena, source snapshot, and Program.

SAFETY invariants:

• program uses ManuallyDrop and is explicitly dropped in Drop::drop() before any field auto-drop runs. This guarantees arena-allocated nodes are gone before ArenaGuard recycles the arena — regardless of field order.
• _source: Arc<str> keeps the source text alive at a stable heap address. The transmuted &'static str in the parser arena remains valid for the lifetime of ParsedDoc because _source is dropped last (after program is manually dropped and after _arena is recycled).
• The 'static lifetimes in ManuallyDrop<Box<Program<'static, 'static>>> are erased versions of the true lifetimes '_arena and '_source. The public program() accessor re-attaches them to &self, preventing any reference from escaping beyond the lifetime of the ParsedDoc.

Fields

errors: Vec<ParseError>

Implementations

impl ParsedDoc

pub fn parse(source: impl Into<Arc<str>>) -> Self

Parse PHP source text. Accepts String, &str, or Arc<str> — when the caller already holds an Arc<str> (e.g. the salsa parsed_doc query), no heap allocation occurs (refcount bump only).

pub fn program(&self) -> &Program<'_, '_>

Borrow the program with lifetimes bounded by &self.

SAFETY: covariance of Program<'arena, 'src> in both parameters lets &Program<'static, 'static> shorten to &Program<'_, '_>.

pub fn source(&self) -> &str

Borrow the source text used when parsing.

pub fn source_arc(&self) -> Arc<str>

Clone the Arc<str> backing the source text (refcount bump only).

Callers that need to store the same source text in a salsa input should use this to get the identical pointer — enabling cheap Arc::ptr_eq validation in the parsed_cache.

pub fn line_starts(&self) -> &[u32]

Borrow the precomputed line-start byte offsets. line_starts[i] is the byte offset of the first character on line i.

pub fn view(&self) -> SourceView<'_>

Bundle source and line index for position lookups.

pub fn file_imports(&self) -> Arc<HashMap<String, String>>

use-statement local-name → FQN map, memoized on first call for this ParsedDoc (see imports_cache). Callers only ever read the map, so the returned Arc is a refcount bump on every call after the first.

Trait Implementations

impl Default for ParsedDoc

fn default() -> Self

Returns the “default value” for a type.

impl Drop for ParsedDoc

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for ParsedDoc

impl Sync for ParsedDoc