Struct Span 

#[non_exhaustive]
pub struct Span {
    pub start_line: usize,
    pub start_col: usize,
    pub end_line: usize,
    pub end_col: usize,
    pub start_byte: usize,
    pub end_byte: usize,
}

Start and end positions of a node in a code in terms of lines, columns, and byte offsets.

Serialized as a flat object {start_line, start_col, end_line, end_col, start_byte, end_byte}. The line/column pairs are 1-based; the byte offsets are 0-based half-open ([start_byte, end_byte)) indices into the parsed source bytes (Ast::source). The *_line vocabulary aligns the /ast span field names with the /function and /metrics endpoints (start_line / end_line), so a client correlating spans across endpoints no longer special-cases *_row vs *_line per endpoint (#638). The former start_row / end_row keys were renamed as a 2.0-line break.

The byte offsets let structural consumers slice the original source for a node — including internal nodes, whose value text the dump omits — so a caller can recover any subtree’s exact bytes without re-deriving offsets from lines and columns (#727). They mirror tree-sitter’s own Node::start_byte / Node::end_byte.

The struct is #[non_exhaustive]: construct it through Span::new and read its public fields, but do not rely on struct-literal construction or exhaustive destructuring from outside the crate. This is the last planned shape break to the type. The two byte fields carry #[serde(default)] so span objects serialized before they existed still deserialize (the offsets default to 0).

A node’s span is None for the root and any node when span tracking is disabled; in that case the wrapping Option<Span> serializes as null.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

start_line: usize

Line of the start position (1-based).

start_col: usize

Column of the start position (1-based).

end_line: usize

Line of the end position (1-based).

end_col: usize

Column of the end position (1-based).

start_byte: usize

Byte offset of the node’s first byte in the source (0-based).

end_byte: usize

Byte offset one past the node’s last byte in the source (0-based, exclusive).

Implementations

impl Span

pub fn new( start_line: usize, start_col: usize, end_line: usize, end_col: usize, start_byte: usize, end_byte: usize, ) -> Self

Builds a Span from 1-based line/column pairs and 0-based, half-open byte offsets ([start_byte, end_byte)).

This is the supported construction path now that the struct is #[non_exhaustive].

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 Copy for Span

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 Eq for Span

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 StructuralPartialEq for Span