Struct Span 

pub struct Span {
    pub start: Marker,
    pub end: Marker,
    pub indent: Option<usize>,
    pub tag_start: Option<Marker>,
}

A range of locations in a YAML document.

Fields

start: Marker

The start (inclusive) of the range.

end: Marker

The end (exclusive) of the range.

indent: Option<usize>

Optional indentation hint associated with this span.

This is only meaningful for certain parser-emitted events (notably: block mapping keys). When indentation is not meaningful or cannot be provided, it must be None.

tag_start: Option<Marker>

Optional source marker for the explicit tag token attached to this node.

This is only meaningful for parser-emitted node events that carry a resolved tag, such as Event::Scalar, Event::SequenceStart, or Event::MappingStart. The normal Span::start and Span::end continue to cover the node value or collection; tag_start points to the tag token when that token appears at a different source location.

Implementations

impl Span

pub fn new(start: Marker, end: Marker) -> Span

Create a new Span for the given range.

pub fn empty(mark: Marker) -> Span

Create an empty Span at a given location.

An empty span doesn’t contain any characters, but its position may still be meaningful. For example, for an indented sequence SequenceEnd has a location but an empty span.

pub fn with_indent(self, indent: Option<usize>) -> Span

Return a copy of this Span with the given indentation hint.

pub fn with_tag_start(self, tag_start: Option<Marker>) -> Span

Return a copy of this Span with the given explicit tag-token start marker.

pub fn tag_start(&self) -> Option<Marker>

Return the source marker of the explicit tag token attached to this node, if any.

The regular span still covers the node value or collection. This accessor is useful for diagnostics that should point at the tag itself, especially when a tagged block collection begins on a later line than the tag token.

pub fn len(&self) -> usize

Return the length of the span (in characters).

pub fn is_empty(&self) -> bool

Return whether the Span has a length of zero.

pub fn byte_range(&self) -> Option<Range<usize>>

Return the byte range of the span, if available.

pub fn slice<'source>(&self, source: &'source str) -> Option<&'source str>

Return the source text covered by this span, if byte offsets are available and the range is valid for the provided input.

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