Struct Span

#[non_exhaustive]
pub struct Span<I> {
    pub start: I,
    pub end: I,
}

A span in the source code, akin to start..end so the end of the span is exclusive.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

start: I

The start of the span.

end: I

The end of the span.

Implementations

impl<I> Span<I>

pub const fn new(start: I, end: I) -> Self

Construct a new span.

Examples

use syntree::Span;

let span = Span::new(4u32, 8u32);

assert_eq!(span.start, 4);
assert_eq!(span.end, 8);

pub const fn point(at: I) -> Self

where I: Copy,

Construct a span corresponding to the given point.

Examples

use syntree::Span;

assert_eq!(Span::point(4u32), Span::new(4u32, 4u32));

pub fn join(&self, other: &Self) -> Self

where I: Copy + Ord,

Join the current span with another.

Examples

use syntree::Span;

let a = Span::new(4u32, 8u32);
let b = Span::new(5u32, 9u32);

let span = a.join(&b);

assert_eq!(span.start, 4);
assert_eq!(span.end, 9);
assert_eq!(span, b.join(&a));

pub fn is_empty(&self) -> bool

where I: Eq,

Test if the span is empty.

Examples

use syntree::Span;

assert!(Span::new(0u32, 0u32).is_empty());
assert!(!Span::new(0u32, 10u32).is_empty());

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

where I: PartialOrd<U>, U: PartialOrd<I> + ?Sized,

Test if span contains the given index.

Examples

use syntree::Span;

assert!(!Span::new(2u32, 2u32).contains(&2));
assert!(Span::new(2u32, 3u32).contains(&2));
assert!(!Span::new(2u32, 3u32).contains(&3));

impl<I> Span<I>

where I: Index,

pub fn range(self) -> Range<usize>

Coerce into a ops::Range which is useful for slicing.

Examples

use syntree::Span;

let a = Span::new(4u32, 8u32);

assert_eq!(a.range(), 4..8);

pub fn len(&self) -> I::Length

The length of the span.

Examples

use syntree::Span;

assert_eq!(Span::new(0u32, 0u32).len(), 0);
assert_eq!(Span::new(0u32, 10u32).len(), 10);

Trait Implementations

impl<I: Clone> Clone for Span<I>

fn clone(&self) -> Span<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Debug for Span<I>

where I: Debug,

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

Formats the value using the given formatter.

impl<I> Display for Span<I>

where I: Display,

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

Formats the value using the given formatter.

impl<I: Hash> Hash for Span<I>

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<I: Ord> Ord for Span<I>

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<I> PartialEq<&Span<I>> for Span<I>

where I: PartialEq,

fn eq(&self, other: &&Span<I>) -> 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<A, B> PartialEq<Span<A>> for Span<B>

where B: PartialEq<A>,

fn eq(&self, other: &Span<A>) -> 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<I> PartialEq<Span<I>> for &Span<I>

where I: PartialEq,

fn eq(&self, other: &Span<I>) -> 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<I: PartialOrd> PartialOrd for Span<I>

fn partial_cmp(&self, other: &Span<I>) -> 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<I: Copy> Copy for Span<I>

impl<I: Eq> Eq for Span<I>