Struct lumberjack::Span

pub struct Span {
    pub start: usize,
    pub end: usize,
    // some fields omitted
}

Span of a node.

Spans are non-empty ranges that optionally skip indices.

Spans are non-inclusive and do not cover the end.

Fields

start: usize

Lower bounds of the span.

end: usize

Upper bounds of the span.

Methods

impl Span

pub fn contains(&self, index: usize) -> bool

Return whether the span covers the index.

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

Return whether the span covers a superset of indices of another span.

pub fn bounds(&self) -> (usize, usize)

Get this spans bounds as a tuple.

pub fn n_indices(&self) -> usize

Get the number of indices covered.

pub fn skips(&self) -> Option<&HashSet<usize>>

Get the skipped indices of this span.

Returns None if the span is continuous.

Trait Implementations

impl PartialEq<Span> for Span

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl From<usize> for Span

fn from(idx: usize) -> Self

Performs the conversion.

impl Clone for Span

fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Span

fn cmp(&self, other: &Span) -> Ordering

Order of spans is determined by:

1. start index
2. end index
3. number of covered indices.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> IntoIterator for &'a Span

type Item = usize

The type of the elements being iterated over.

type IntoIter = SpanIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> SpanIter<'a>

Creates an iterator from a value.

impl Eq for Span

impl PartialOrd<Span> for Span

fn partial_cmp(&self, other: &Span) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for Span

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

Formats the value using the given formatter.