Struct nu_source::Tag

pub struct Tag {
    pub anchor: Option<AnchorLocation>,
    pub span: Span,
}

The set of metadata that can be associated with a value

Fields

anchor: Option<AnchorLocation>

The original source for this value

span: Span

The span in the source text for the command that created this value

Implementations

impl Tag

pub fn new(anchor: Option<AnchorLocation>, span: Span) -> Self

Constructs a new Tag.

impl Tag

pub fn default() -> Self

Creates a default Tag' with unknown Spanposition and noAnchorLocation`

pub fn anchored(self, anchor: Option<AnchorLocation>) -> Tag

pub fn unknown_anchor(span: Span) -> Tag

Creates a Tag from the given Span with no AnchorLocation

pub fn for_char(pos: usize, anchor: AnchorLocation) -> Tag

Creates a Tag from the given AnchorLocation for a span with a length of 1.

pub fn unknown_span(anchor: AnchorLocation) -> Tag

Creates a Tag for the given AnchorLocation with unknown Span position.

pub fn unknown() -> Tag

Creates a Tag with no AnchorLocation and an unknown Span position.

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

Returns the AnchorLocation of the current Tag

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

Both Tags must share the same AnchorLocation.

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

Merges the current Tag with the given optional Tag.

Both Tags must share the same AnchorLocation. The resulting Tag will have a Span that starts from the current Tag and ends at Span of the given Tag. Should the None variant be passed in, a new Tag with the same Span and AnchorLocation will be returned.

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

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

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

pub fn tagged_string(&self, source: &str) -> Tagged<String>

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

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Default for Tag

fn default() -> Tag

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tag

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

Deserialize this value from the given Serde deserializer.

impl Eq for Tag

impl From<&'_ Span> for Tag

fn from(span: &Span) -> Self

Performs the conversion.

impl From<&'_ Tag> for Tag

fn from(input: &Tag) -> Tag

Performs the conversion.

impl From<&'_ Tag> for Span

fn from(tag: &Tag) -> Self

Performs the conversion.

impl From<(usize, usize, AnchorLocation)> for Tag

fn from((start, end, anchor): (usize, usize, AnchorLocation)) -> Self

Performs the conversion.

impl From<(usize, usize, Option<AnchorLocation>)> for Tag

fn from((start, end, anchor): (usize, usize, Option<AnchorLocation>)) -> Self

Performs the conversion.

impl From<Span> for Tag

fn from(span: Span) -> Self

Performs the conversion.

impl From<Tag> for Span

fn from(tag: Tag) -> Self

Performs the conversion.

impl Hash for Tag

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 Tag

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

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

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

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

This method tests for !=.

impl PartialOrd<Tag> for Tag

fn partial_cmp(&self, other: &Tag) -> 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 Serialize for Tag

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 Tag

impl StructuralPartialEq for Tag