Struct Span 

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

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.

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 a 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 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.

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

fn default() -> Span

Returns the “default value” for a type.

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

impl Eq for Span

impl StructuralPartialEq for Span