Struct Span 

pub struct Span {
    pub start: SpanValue,
    pub end: SpanValue,
}

The Span type represents an area of a file.

Fields

start: SpanValue

The start of the Span (Inclusive)

end: SpanValue

The end of the Span (Exclusive)

Implementations

impl Span

pub fn new() -> Self

Creates a new Span. This span will start and end at the 0th character, making it have a length of zero.

pub fn new_from(start: SpanValue, end: SpanValue) -> Self

Creates a new Span from a pair of start and end indexes.

Panics

Panics if start is greater than end, since spans can’t have a negative length.

pub fn grow_front(&mut self, amount: SpanValue)

Grows the span from the front. This moves the end value up by amount.

pub fn with_grow_front(&self, amount: SpanValue) -> Self

Returns a span that is grown from the front. This moves the end value up by amount.

pub fn grow_back(&mut self, amount: SpanValue)

Grows the span from the back. This moves the start value back by amount.

Panics

Panics if the start of the span is less than amount, since spans can’t have a negative start value,

pub fn with_grow_back(&self, amount: SpanValue) -> Self

Returns a span that is grown from the back. This moves the start value back by amount.

Panics

Panics if the start of the span is less than amount, since spans can’t have a negative start value,

pub fn shrink_back(&mut self, amount: SpanValue)

Shrinks the span from the back. This moves the start value up by amount.

Panics

Panics if the size of the Span is less than amount, since a Span’s size can’t be negative.

pub fn with_shrink_back(&self, amount: SpanValue) -> Self

Returns a span that is shrunk from the back. This moves the start value up by amount.

Panics

Panics if the size of the Span is less than amount, since a Span’s size can’t be negative.

pub fn shrink_front(&mut self, amount: SpanValue)

Shrinks the span from the front. This moves the end value back by amount.

Panics

This method will panic if the size of the Span is less than amount, since a Span’s size can’t be negative.

pub fn with_shrink_front(&self, amount: SpanValue) -> Self

Returns a span shrunk from the front. This moves the end value back by amount.

Panics

This method will panic if the size of the Span is less than amount, since a Span’s size can’t be negative.

pub fn is_empty(&self) -> bool

Checks if a Span’s size is 0. Returns true if 0, and false if anything else.

pub fn len(&self) -> SpanValue

Gets the length of a Span.

pub fn reset(&mut self) -> Self

Resets self by changing the start to be the end, plus 1, and changing the end to be the start. The function also returns the old span.

pub fn apply<'a>(&self, string: &'a str) -> &'a str

Applies the span to string, with start and end corresponding to char indexes.

Panics

Panics if string is shorter than the end of the span.

pub fn apply_bytes<'a>(&self, string: &'a str) -> &'a str

Applies the span to string, with start and end corresponding to byte indexes.

Panics

Panics if string is shorter than the end of the 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 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 From<Range<usize>> for Span

fn from(value: Range<SpanValue>) -> Self

Converts to this type from the input type.

impl From<Span> for Range<SpanValue>

fn from(val: Span) -> Self

Converts to this type from the input type.

impl Hash for Span

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Span

impl Eq for Span

impl StructuralPartialEq for Span