Struct SourceDocument 

pub struct SourceDocument { /* private fields */ }

An immutable, contiguous source document with stable line coordinates.

The source text is retained as one allocation. line_starts makes line lookup and byte spans constant time without copying or normalizing the document.

Implementations

impl SourceDocument

pub fn new(text: impl AsRef<str>) -> Result<Self, SourceUnavailable>

Captures one immutable source document.

Errors

Returns a typed unavailable reason when the source exceeds the complete-file byte or line limits.

pub fn try_from_text(text: &str) -> Result<Self, SourceUnavailable>

Captures exact byte identity while normalizing rendered line endings like patch parsing.

Errors

Returns a typed unavailable reason before allocating normalized lines when the source exceeds the complete-file byte or line limits.

pub fn line(&self, number: usize) -> Option<&str>

Returns a one-based normalized source line.

pub fn line_span(&self, number: usize) -> Option<Range<usize>>

Returns the zero-based byte span of a one-based source line.

pub fn text(&self) -> &str

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

pub const fn identity(&self) -> Fingerprint

pub fn line_count(&self) -> usize

pub const fn content_id(&self) -> Fingerprint

pub const fn sequence_id(&self) -> SourceSequenceId

pub const fn byte_len(&self) -> u64

pub const fn trailing_newline(&self) -> bool

Trait Implementations

impl Clone for SourceDocument

fn clone(&self) -> SourceDocument

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SourceDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceDocument

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for SourceDocument

impl PartialEq for SourceDocument

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SourceDocument

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.