Enum ShellValue 

pub enum ShellValue {
    Unset(ShellValueUnsetType),
    String(String),
    AssociativeArray(BTreeMap<String, String>),
    IndexedArray(BTreeMap<u64, String>),
    Dynamic {
        getter: fn(&dyn ShellState) -> ShellValue,
        setter: fn(&dyn ShellState),
    },
}

A shell value.

Variants

Unset(ShellValueUnsetType)

A value that has been typed but not yet set.

String(String)

A string.

AssociativeArray(BTreeMap<String, String>)

An associative array.

IndexedArray(BTreeMap<u64, String>)

An indexed array.

Dynamic

A value that is dynamically computed.

Fields

getter: fn(&dyn ShellState) -> ShellValue

Function that can query the value. TODO(serde): figure out how to serialize/deserialize dynamic values.

setter: fn(&dyn ShellState)

Function that receives value update requests. TODO(serde): figure out how to serialize/deserialize dynamic values.

Implementations

impl ShellValue

pub const fn is_indexed_array(&self) -> bool

Returns whether or not the value is an indexed array, including a declared but unset one.

pub const fn is_associative_array(&self) -> bool

Returns whether or not the value is an associative array, including a declared but unset one.

pub const fn is_array(&self) -> bool

Returns whether or not the value is an array.

pub const fn is_set(&self) -> bool

Returns whether or not the value is set.

pub fn indexed_array_from_strings<S>(values: S) -> Self

where S: IntoIterator<Item = String>,

Returns a new indexed array value constructed from the given slice of owned strings.

Arguments

• values - The slice of strings to construct the indexed array from.

pub fn indexed_array_from_strs(values: &[&str]) -> Self

Returns a new indexed array value constructed from the given slice of unowned strings.

Arguments

• values - The slice of strings to construct the indexed array from.

pub fn indexed_array_from_literals(literals: ArrayLiteral) -> Self

Returns a new indexed array value constructed from the given literals.

Arguments

• literals - The literals to construct the indexed array from.

pub fn associative_array_from_literals( literals: ArrayLiteral, ) -> Result<Self, Error>

Returns a new associative array value constructed from the given literals.

Arguments

• literals - The literals to construct the associative array from.

Errors

Returns error::ErrorKind::Unimplemented if the literal has misaligned keys and values.

pub fn format( &self, style: FormatStyle, shell: &Shell<impl ShellExtensions>, ) -> Result<Cow<'_, str>, Error>

Formats the value using the given style.

Arguments

• style - The style to use for formatting the value.

Errors

Returns error::ErrorKind::FormattingError if writing the formatted text fails, or any error from resolving a dynamic value.

pub fn get_at( &self, index: &str, shell: &Shell<impl ShellExtensions>, ) -> Result<Option<Cow<'_, str>>, Error>

Tries to retrieve the value stored at the given index in this variable.

Arguments

• index - The index at which to retrieve the value.

Errors

Returns error::ErrorKind::ArrayIndexOutOfRange if the value is an indexed array and index is negative and reaches before the first element.

pub fn element_keys(&self, shell: &Shell<impl ShellExtensions>) -> Vec<String>

Returns the keys of the elements in this variable.

pub fn element_values(&self, shell: &Shell<impl ShellExtensions>) -> Vec<String>

Returns the values of the elements in this variable.

pub fn to_cow_str(&self, shell: &Shell<impl ShellExtensions>) -> Cow<'_, str>

Converts this value to a string.

pub fn try_get_cow_str( &self, shell: &Shell<impl ShellExtensions>, ) -> Option<Cow<'_, str>>

Tries to convert this value to a string; returns None if the value is unset or otherwise doesn’t exist.

pub fn to_assignable_str( &self, index: Option<&str>, shell: &Shell<impl ShellExtensions>, ) -> Result<String, Error>

Formats this value as a program string usable in an assignment.

Arguments

• index - The index at which to retrieve the value, if indexing is to be performed.

Errors

Returns error::ErrorKind::FormattingError if formatting an array value fails.

Trait Implementations

impl Clone for ShellValue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShellValue

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&String> for ShellValue

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for ShellValue

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<OsString> for ShellValue

fn from(value: OsString) -> Self

Converts to this type from the input type.

impl From<String> for ShellValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<&str>> for ShellValue

fn from(values: Vec<&str>) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for ShellValue

fn from(values: Vec<String>) -> Self

Converts to this type from the input type.

impl Serialize for ShellValue

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.