Struct calypso_base::span::Span

pub struct Span {
    lo: u32,
    hi: u32,
}

The location in a slice in which some object spans.

Fields

lo: u32

hi: u32

Implementations

impl Span

pub fn new(lo: u32, hi: u32) -> Self

Create a new span given the low and high indices.

pub fn new_shrunk(amount: u32) -> Self

Create a new empty span around an index.

pub fn new_dummy() -> Self

Create a dummy span (that has a span equivalent to the range 0..0).

pub fn lo(self) -> u32

Get the low index of a span.

pub fn with_lo(self, lo: u32) -> Self

Set the low index of a span.

pub fn hi(self) -> u32

Get the high index of a span.

pub fn with_hi(self, hi: u32) -> Self

Set the high index of a span.

pub fn is_dummy(self) -> bool

Returns true if this is a dummy span

pub fn shrink_to_lo(self) -> Span

Returns a new span representing an empty span at the beginning of this span

pub fn shrink_to_hi(self) -> Span

Returns a new span representing an empty span at the end of this span.

pub fn is_empty(self) -> bool

Returns true if if hi == lo

pub fn substitute_dummy(self, other: Span) -> Span

Returns self if self is not a dummy span, and other otherwise.

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

Returns true if self fully encloses other.

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

Returns true if self touches other.

pub fn to(self, end: Span) -> Span

Returns a Span that would enclose both self and end.

    ____             ___
    self lorem ipsum end
    ^^^^^^^^^^^^^^^^^^^^

pub fn between(self, end: Span) -> Span

Returns a Span between the end of self to the beginning of end.

    ____             ___
    self lorem ipsum end
        ^^^^^^^^^^^^^

pub fn until(self, end: Span) -> Span

Returns a Span from the beginning of self until the beginning of end.

    ____             ___
    self lorem ipsum end
    ^^^^^^^^^^^^^^^^^

pub fn add_hi(self, amount: u32) -> Span

Add the given amount to the high index of a span.

pub fn sub_hi(self, amount: u32) -> Span

Subtract the given amount from the high index of a span.

pub fn add_lo(self, amount: u32) -> Span

Add the given amount to the low index of a span.

pub fn sub_lo(self, amount: u32) -> Span

Subtract the given amount from the low index of a span.

pub fn len(self) -> u32

Get the length (hi - lo) of a span.

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

Convert to a Range. (This function present to prevent generics hell.)

Trait Implementations

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

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

Formats the value using the given formatter.

impl Default for Span

fn default() -> Self

Returns the “default value” for a type.

impl From<Range<u32>> for Span

fn from(range: Range<u32>) -> Self

Converts to this type from the input type.

impl From<Span> for Range<u32>

fn from(span: Span) -> Self

Converts to this type from the input type.

impl From<Span> for Range<usize>

fn from(span: 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 Ord for Span

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

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

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

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

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

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

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

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

impl Eq for Span

impl StructuralEq for Span

impl StructuralPartialEq for Span