Struct Span 

pub struct Span {
    pub start: Position,
    pub end: Position,
}

A span representing a range in the source document.

Spans are inclusive of the start position and exclusive of the end position. This matches CommonMark and most parser conventions.

Example

For the text “bold”:

• start: Position at the first ‘*’
• end: Position after the last ‘*’ (one past the last character)

Multi-line Spans

For multi-line content like code blocks, for example a fenced Rust code block, the inner code might look like:

fn main() {
}

• start.line: Line of opening backticks
• end.line: Line after closing backticks
• Columns are byte offsets within their respective lines

Fields

start: Position

Start position (inclusive)

end: Position

End position (exclusive)

Implementations

impl Span

pub fn new(start: Position, end: Position) -> Self

Create a new span from inclusive start and exclusive end positions.

pub fn start_line_offset(&self) -> usize

Return the absolute byte offset of the start of the span’s first line.

This is a convenience wrapper around Position::line_start_offset for the span’s start position.

pub fn end_line_offset(&self) -> usize

Return the absolute byte offset of the start of the span’s end line. Useful when expanding a span to include the whole end line.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Span

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Span

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Span

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Span

impl Eq for Span

impl StructuralPartialEq for Span