Struct nu_source::Tagged

pub struct Tagged<T> {
    pub tag: Tag,
    pub item: T,
}

A wrapper type that attaches a Tag to a value

Fields

tag: Tag

item: T

Implementations

impl<T> Tagged<T>

pub fn new(tag: Tag, item: T) -> Self

Constructs a new Tagged.

impl Tagged<String>

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

Allows borrowing the contained string slice as a spanned value

pub fn borrow_tagged(&self) -> Tagged<&str>

Allows borrowing the contained string slice as a tagged value

impl<T> Tagged<Vec<T>>

pub fn items(&self) -> impl Iterator<Item = &T>

Iterates over the contained value(s)

impl<T> Tagged<T>

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

pub fn map_anchored(self, anchor: &Option<AnchorLocation>) -> Tagged<T>

pub fn transpose(&self) -> Tagged<&T>

pub fn tag(&self) -> Tag

Creates a new Tag from the current Tag

pub fn span(&self) -> Span

Retrieve the Span for the current Tag.

pub fn anchor(&self) -> Option<AnchorLocation>

Returns the AnchorLocation of the Tag if there is one.

pub fn anchor_name(&self) -> Option<String>

Returns the underlying AnchorLocation variant type as a string.

pub fn item(&self) -> &T

Returns a reference to the current Tag's item.

pub fn into_parts(self) -> (T, Tag)

Returns a tuple of the Tagged item and Tag.

Trait Implementations

impl AsRef<Path> for Tagged<PathBuf>

fn as_ref(&self) -> &Path

Gets the reference to the contained Path

impl<T: Clone> Clone for Tagged<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Tagged<T>

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

Formats the value using the given formatter.

impl<T> Deref for Tagged<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'de, T> Deserialize<'de> for Tagged<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 Tagged<T>

impl<T> HasSpan for Tagged<T>

fn span(&self) -> Span

impl<T> HasTag for Tagged<T>

fn tag(&self) -> Tag

Helper for getting the Tag from the Tagged value

impl<T: Hash> Hash for Tagged<T>

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, 

Feeds a slice of this type into the given [Hasher].

impl<T: Ord> Ord for Tagged<T>

fn cmp(&self, other: &Tagged<T>) -> Ordering

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Tagged<T>> for Tagged<T>

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

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

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Tagged<T>> for Tagged<T>

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

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

fn lt(&self, other: &Tagged<T>) -> bool

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

fn le(&self, other: &Tagged<T>) -> bool

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

fn gt(&self, other: &Tagged<T>) -> bool

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

fn ge(&self, other: &Tagged<T>) -> bool

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

impl<T> Serialize for Tagged<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 Tagged<T>

impl<T> StructuralPartialEq for Tagged<T>