Struct nu_protocol::Dictionary

pub struct Dictionary {
    pub entries: IndexMap<String, Value>,
}

A dictionary that can hold a mapping from names to Values

Fields

entries: IndexMap<String, Value>

Implementations

impl Dictionary

pub fn entries(&self) -> &IndexMap<String, Value>

impl Dictionary

pub fn new(entries: IndexMap<String, Value>) -> Self

Constructs a new Dictionary.

impl Dictionary

pub fn get_data(&self, desc: &str) -> MaybeOwned<'_, Value>

Find the matching Value for a given key, if possible. If not, return a Primitive::Nothing

pub fn merge_from(&self, other: &Dictionary) -> Dictionary

pub fn keys(&self) -> impl Iterator<Item = &String>

Iterate the keys in the Dictionary

pub fn values(&self) -> impl Iterator<Item = &Value>

Iterate the values in the Dictionary

pub fn contains_key(&self, key: &str) -> bool

Checks if given key exists

pub fn get_data_by_key(&self, name: Spanned<&str>) -> Option<Value>

Find the matching Value for a key, if possible

pub fn get_mut_data_by_key(&mut self, name: &str) -> Option<&mut Value>

Get a mutable entry that matches a key, if possible

pub fn insert_data_at_key(&mut self, name: &str, value: Value)

Insert a new key/value pair into the dictionary

pub fn length(&self) -> usize

Return size of dictionary

Trait Implementations

impl Clone for Dictionary

fn clone(&self) -> Dictionary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dictionary

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

Formats the value using the given formatter.

impl Default for Dictionary

fn default() -> Dictionary

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Dictionary

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

Deserialize this value from the given Serde deserializer.

impl Eq for Dictionary

impl From<IndexMap<String, Value, RandomState>> for Dictionary

fn from(input: IndexMap<String, Value>) -> Dictionary

Create a dictionary from a map of strings to Values

impl Hash for Dictionary

fn hash<H: Hasher>(&self, state: &mut H)

Create the hash function to allow the Hash trait for dictionaries

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 Dictionary

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

Compare two dictionaries for ordering

#[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 PartialEq<Dictionary> for Dictionary

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

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

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

This method tests for !=.

impl PartialEq<Value> for Dictionary

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

Test a dictionary against a Value for equality

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Dictionary> for Dictionary

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

Compare two dictionaries for sort ordering

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]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]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 Dictionary

fn pretty(&self) -> DebugDocBuilder

Get a Dictionary 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 Dictionary

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 Dictionary

impl StructuralPartialEq for Dictionary

impl<'a> TryFrom<&'a Value> for &'a Dictionary

type Error = ShellError

The type returned in the event of a conversion error.

fn try_from(value: &'a Value) -> Result<&'a Dictionary, ShellError>

Convert to a dictionary, if possible