Struct nu_protocol::value::column_path::ColumnPath

pub struct ColumnPath { /* fields omitted */ }

The fundamental path primitive to describe how to navigate through a table to get to a sub-item. A path member can be either a word or a number. Words/strings are taken to mean a column name, and numbers are the row number. Taken together they describe which column or row to narrow to in order to get data.

Rows must follow column names, they can’t come first. eg) foo.1 is valid where 1.foo is not.

Implementations

impl ColumnPath

pub fn members(&self) -> &Vec<PathMember>

impl ColumnPath

pub fn new(members: Vec<PathMember>) -> Self

Constructs a new ColumnPath.

impl ColumnPath

pub fn iter(&self) -> impl Iterator<Item = &PathMember>

Iterate over the members of the column path

pub fn is_empty(&self) -> bool

pub fn split_last(&self) -> Option<(&PathMember, &[PathMember])>

Returns the last member and a slice of the remaining members

pub fn last(&self) -> Option<&PathMember>

Returns the last member

pub fn path(&self) -> String

pub fn build(text: &Spanned<String>) -> ColumnPath

pub fn with_head(text: &Spanned<String>) -> Option<(String, ColumnPath)>

Trait Implementations

impl Clone for ColumnPath

fn clone(&self) -> ColumnPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnPath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColumnPath

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

Deserialize this value from the given Serde deserializer.

impl HasFallibleSpan for ColumnPath

fn maybe_span(&self) -> Option<Span>

Creates a span that will cover the column path, if possible

impl Hash for ColumnPath

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<'a> IntoIterator for &'a ColumnPath

type Item = &'a PathMember

The type of the elements being iterated over.

type IntoIter = Iter<'a, PathMember>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for ColumnPath

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ColumnPath> for ColumnPath

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

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

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

This method tests for !=.

impl PartialOrd<ColumnPath> for ColumnPath

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

fn pretty(&self) -> DebugDocBuilder

Gets the ColumnPath ready to be pretty-printed

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 Serialize for ColumnPath

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

Serialize this value into the given Serde serializer.

impl Eq for ColumnPath

impl StructuralEq for ColumnPath

impl StructuralPartialEq for ColumnPath