Struct Span 

pub struct Span {
    pub source: u16,
    pub line: u32,
    pub start: u32,
    pub end: u32,
}

Source provenance of a node: which source it came from, the 1-based line docutils would report for it, and the byte range of its text.

source indexes the per-doctree source table (Doctree::sources; 0 is the document itself, included files push further entries), and start..end is a byte range into the parser’s processed text of that source (tab-expanded, trailing whitespace stripped — the text the parser actually consumed).

line is 1-based within source; 0 means unknown. It carries the docutils reporting convention the env layer’s warnings need: every node is stamped with the first line of its span, except a section, which is stamped one past that (docutils creates a section only once the state machine has consumed the title’s underline).

Default is Span::ZERO: source 0, line 0 (unknown), empty range.

Fields

source: u16

line: u32

start: u32

end: u32

Implementations

impl Span

pub const ZERO: Span

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

fn default() -> Span

Returns the “default value” for a type.

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

Equality operator ==.

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

Inequality operator !=.

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