Enum conch_runtime::eval::Fields

pub enum Fields<T> {
    Zero,
    Single(T),
    At(Vec<T>),
    Star(Vec<T>),
    Split(Vec<T>),
}

Represents the types of fields that may result from evaluating a word. It is important to maintain such distinctions because evaluating parameters such as $@ and $* have different behaviors in different contexts.

Variants

Zero

No fields, distinct from present-but-null fields.

Single(T)

A single field.

At(Vec<T>)

Any number of fields resulting from evaluating the $@ special parameter.

Star(Vec<T>)

Any number of fields resulting from evaluating the $* special parameter.

Split(Vec<T>)

A non-zero number of fields resulting from splitting, and which do not have any special meaning.

Methods

impl<T: StringWrapper> Fields<T>

pub fn is_null(&self) -> bool

Indicates if a set of fields is considered null.

A set of fields is null if every single string it holds is the empty string.

pub fn join(self) -> T

Joins all fields using a space.

Note: Zero is treated as a empty-but-present field for simplicity.

pub fn join_with_ifs<E: ?Sized>(self, env: &E) -> T where     E: VariableEnvironment,     E::VarName: Borrow<String>,     E::Var: Borrow<String>,

Joins any field unconditionally with the first character of $IFS. If $IFS is unset, fields are joined with a space, or concatenated if $IFS is empty.

Note: Zero is treated as a empty-but-present field for simplicity.

pub fn split<E: ?Sized>(self, env: &E) -> Fields<T> where     E: VariableEnvironment,     E::VarName: Borrow<String>,     E::Var: Borrow<String>,

Splits a vector of fields further based on the contents of the IFS variable (i.e. as long as it is non-empty). Any empty fields, original or otherwise created will be discarded.

Trait Implementations

impl<T: PartialEq> PartialEq for Fields<T>

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

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

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

This method tests for !=.

impl<T: Eq> Eq for Fields<T>

impl<T: Clone> Clone for Fields<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Fields<T>

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

Formats the value using the given formatter.

impl<T> From<Vec<T>> for Fields<T>

fn from(fields: Vec<T>) -> Self

Performs the conversion.

impl<T> From<T> for Fields<T>

fn from(t: T) -> Self

Performs the conversion.

impl<T> IntoIterator for Fields<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.