Struct nu_source::Span

pub struct Span { /* fields omitted */ }

A Span is metadata which indicates the start and end positions.

Spans are combined with AnchorLocations to form another type of metadata, a Tag. A Span's end position must be greater than or equal to its start position.

Implementations

impl Span

pub fn default() -> Self

Creates a default new Span that has 0 start and 0 end.

pub fn unknown() -> Span

Creates a new Span that has 0 start and 0 end.

pub fn new(start: usize, end: usize) -> Span

Creates a new Span from start and end inputs. The end parameter must be greater than or equal to the start parameter.

pub fn for_char(pos: usize) -> Span

Creates a Span with a length of 1 from the given position.

Example

let char_span = Span::for_char(5);

assert_eq!(char_span.start(), 5);
assert_eq!(char_span.end(), 6);

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

Returns a bool indicating if the given position falls inside the current Span.

Example

let span = Span::new(2, 8);

assert_eq!(span.contains(5), true);
assert_eq!(span.contains(8), false);
assert_eq!(span.contains(100), false);

pub fn since(&self, other: impl Into<Span>) -> Span

Returns a new Span by merging an earlier Span with the current Span.

The resulting Span will have the same start position as the given Span and same end as the current Span.

Example

let original_span = Span::new(4, 6);
let earlier_span = Span::new(1, 3);
let merged_span = origin_span.since(earlier_span);

assert_eq!(merged_span.start(), 1);
assert_eq!(merged_span.end(), 6);

pub fn until(&self, other: impl Into<Span>) -> Span

Returns a new Span by merging a later Span with the current Span.

The resulting Span will have the same start position as the current Span and same end as the given Span.

Example

let original_span = Span::new(4, 6);
let later_span = Span::new(9, 11);
let merged_span = origin_span.until(later_span);

assert_eq!(merged_span.start(), 4);
assert_eq!(merged_span.end(), 11);

pub fn until_option(&self, other: Option<impl Into<Span>>) -> Span

Returns a new Span by merging a later Span with the current Span.

If the given Span is of the None variant, A Span with the same values as the current Span is returned.

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

pub fn spanned_slice<'a>(&self, source: &'a str) -> Spanned<&'a str>

pub fn spanned_string<'a>(&self, source: &'a str) -> Spanned<String>

pub fn start(&self) -> usize

Returns the start position of the current Span.

pub fn end(&self) -> usize

Returns the end position of the current Span.

pub fn is_unknown(&self) -> bool

Returns a bool if the current Span indicates an "unknown" position.

Example

let unknown_span = Span::unknown();
let known_span = Span::new(4, 6);

assert_eq!(unknown_span.is_unknown(), true);
assert_eq!(known_span.is_unknown(), false);

pub fn is_closed(&self) -> bool

Returns a bool if the current Span does not cover.

Example

//  make clean
//  ----
//  (0,4)
//
//       ^(5,5)

let make_span = Span::new(0,4);
let clean_span = Span::new(5,5);

assert_eq!(make_span.is_closed(), false);
assert_eq!(clean_span.is_closed(), true);

pub fn slice<'a>(&self, source: &'a str) -> &'a str

Returns a slice of the input that covers the start and end of the current Span.

Trait Implementations

impl Clone for Span

pub fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Span

impl Debug for Span

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

Formats the value using the given formatter.

impl Default for Span

pub fn default() -> Span

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Span

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Span

impl<'_> From<&'_ Range<usize>> for Span

pub fn from(input: &Range<usize>) -> Span

Performs the conversion.

impl<'_> From<&'_ Span> for Tag

pub fn from(span: &Span) -> Self

Performs the conversion.

impl<'_> From<&'_ Span> for Span

pub fn from(span: &Span) -> Span

Performs the conversion.

impl<'_> From<&'_ Tag> for Span

pub fn from(tag: &Tag) -> Self

Performs the conversion.

impl From<(usize, usize)> for Span

pub fn from(input: (usize, usize)) -> Span

Performs the conversion.

impl From<Option<Span>> for Span

pub fn from(input: Option<Span>) -> Span

Performs the conversion.

impl From<Span> for Tag

pub fn from(span: Span) -> Self

Performs the conversion.

impl From<Span> for Range<usize>

pub fn from(input: Span) -> Range<usize>

Performs the conversion.

impl From<Tag> for Span

pub fn from(tag: Tag) -> Self

Performs the conversion.

impl HasSpan for Span

pub fn span(&self) -> Span

impl Hash for Span

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Span

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Span> for Span

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

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

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

This method tests for !=.

impl PartialEq<usize> for Span

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Span> for Span

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<usize> for Span

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 PrettyDebugWithSource for Span

pub fn pretty_debug(&self, source: &str) -> DebugDocBuilder

pub fn refined_pretty_debug(
    &self,
    _refine: PrettyDebugRefineKind,
    source: &str
) -> DebugDocBuilder

pub fn debug(&self, source: impl Into<Text>) -> String where
    Self: Clone, 

pub fn debuggable(self, source: impl Into<Text>) -> DebuggableWithSource<Self>

impl Serialize for Span

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Span

impl StructuralPartialEq for Span