Struct nu_source::Spanned

pub struct Spanned<T> {
    pub span: Span,
    pub item: T,
}

A wrapper type that attaches a Span to a value

Fields

span: Span

item: T

Implementations

impl<T> Spanned<T>

pub fn new(span: Span, item: T) -> Self

Constructs a new Spanned.

impl<T> Spanned<T>

pub fn map<U>(self, input: impl FnOnce(T) -> U) -> Spanned<U>

Allows mapping over a Spanned value

impl Spanned<String>

pub fn items<'a, U>(
    items: impl Iterator<Item = &'a Spanned<String>>
) -> impl Iterator<Item = &'a str>

Iterates over the contained String

pub fn borrow_spanned(&self) -> Spanned<&str>

Borrows the contained String

pub fn slice_spanned(&self, span: impl Into<Span>) -> Spanned<&str>

Trait Implementations

impl<T: Clone> Clone for Spanned<T>

fn clone(&self) -> Spanned<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Spanned<T>

impl<T: Debug> Debug for Spanned<T>

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

Formats the value using the given formatter.

impl<T> Deref for Spanned<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Shorthand to deref to the contained value

impl<'de, T> Deserialize<'de> for Spanned<T> where
    T: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Eq for Spanned<T>

impl<T> HasSpan for Spanned<T>

fn span(&self) -> Span

impl<T: Hash> Hash for Spanned<T>

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<T: Ord> Ord for Spanned<T>

fn cmp(&self, other: &Spanned<T>) -> 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<T: PartialEq> PartialEq<Spanned<T>> for Spanned<T>

fn eq(&self, other: &Spanned<T>) -> bool

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

fn ne(&self, other: &Spanned<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Spanned<T>> for Spanned<T>

fn partial_cmp(&self, other: &Spanned<T>) -> 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<T: PrettyDebug> PrettyDebug for Spanned<T>

fn pretty(&self) -> DebugDocBuilder

fn to_doc(&self) -> DebugDoc

fn pretty_doc(
    &self
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

fn pretty_builder(&self) -> DocBuilder<'static, BoxAllocator, ShellAnnotation>

fn display(&self) -> String

A convenience method that prints out the document without colors in 70 columns. Generally, you should use plain_string or colored_string if possible, but display() can be useful for trace lines and things like that, where you don't have control over the terminal.

fn plain_string(&self, width: usize) -> String

fn colored_string(&self, width: usize) -> String

impl<T> Serialize for Spanned<T> where
    T: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T> StructuralEq for Spanned<T>

impl<T> StructuralPartialEq for Spanned<T>