Struct Dictionary 

#[repr(transparent)]
pub struct Dictionary(pub(crate) KVec<KeyValuePair>);

A vector of Neovim (String, Object) pairs.

Tuple Fields

0: KVec<KeyValuePair>

Implementations

impl Dictionary

pub fn as_slice(&self) -> &[KeyValuePair]

Returns a slice of all key-value pairs in the dictionary.

pub fn as_mut_slice(&mut self) -> &mut [KeyValuePair]

Returns a mutable slice of all key-value pairs in the dictionary.

pub fn get<Q>(&self, query: &Q) -> Option<&Object>

where Q: PartialEq<String> + ?Sized,

Returns a reference to the value corresponding to the key.

pub fn get_index<Q>(&self, query: &Q) -> Option<usize>

where Q: PartialEq<String> + ?Sized,

Returns the index of the key-value pair corresponding to the key.

pub fn get_mut<Q>(&mut self, query: &Q) -> Option<&mut Object>

where Q: PartialEq<String> + ?Sized,

Returns a mutable reference to the value corresponding to the key.

pub fn insert<K, V>(&mut self, key: K, value: V)

where K: Into<String>, V: Into<Object>,

Inserts a key-value pair into the dictionary.

pub fn is_empty(&self) -> bool

Returns true if the dictionary contains no elements.

pub fn iter(&self) -> DictIter<'_>

Returns an iterator over the (String, Object) pairs of the dictionary.

pub fn iter_mut(&mut self) -> DictIterMut<'_>

Returns a mutable iterator over the (String, Object) pairs of the dictionary.

pub fn len(&self) -> usize

Returns the number of elements in the dictionary.

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

Returns an iterator over the keys of the dictionary.

pub fn new() -> Dictionary

Creates a new, empty Dictionary.

pub fn non_owning(&self) -> NonOwning<'_, Dictionary>

Returns a non-owning version of this Array.

pub fn swap_remove(&mut self, index: usize) -> KeyValuePair

Removes a KeyValuePair from the Dictionary and returns it.

The removed pair is replaced by the last element of the dictionary.

Panics

Panics if index is out of bounds.

Trait Implementations

impl Clone for Dictionary

fn clone(&self) -> Dictionary

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for Dictionary

fn default() -> Dictionary

Returns the “default value” for a type.

impl DictionaryExt for Dictionary

Implementation of DictionaryExt for Dictionary providing typed getters.

fn get_t<T: OxiExtract>(&self, key: &str) -> Result<T::Out>

Gets a required typed value from the dictionary using the OxiExtract trait.

fn get_opt_t<T: OxiExtract>(&self, key: &str) -> Result<Option<T::Out>>

Gets an optional typed value from the dictionary using the OxiExtract trait.

fn get_dict(&self, keys: &[&str]) -> Result<Option<Dictionary>>

Gets an optional nested Dictionary by traversing a sequence of keys.

fn get_required_dict(&self, keys: &[&str]) -> Result<Dictionary>

Gets a required nested Dictionary by traversing a sequence of keys.

impl<K, V> Extend<(K, V)> for Dictionary

where K: Into<String>, V: Into<Object>,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = (K, V)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<CmdMagic> for Dictionary

fn from(magic: CmdMagic) -> Dictionary

Converts to this type from the input type.

impl From<CommandModifiers> for Dictionary

fn from(mods: CommandModifiers) -> Dictionary

Converts to this type from the input type.

impl From<Dictionary> for Object

fn from(dictionary: Dictionary) -> Object

Converts to this type from the input type.

impl From<EditorContext> for Dictionary

fn from(ctx: EditorContext) -> Dictionary

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for Dictionary

where K: Into<String>, V: Into<Object>,

fn from_iter<I>(iter: I) -> Dictionary

where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl<S> Index<S> for Dictionary

where S: PartialEq<String>,

type Output = Object

The returned type after indexing.

fn index(&self, index: S) -> &<Dictionary as Index<S>>::Output

Performs the indexing (container[index]) operation.

impl<S> IndexMut<S> for Dictionary

where S: PartialEq<String>,

fn index_mut(&mut self, index: S) -> &mut <Dictionary as Index<S>>::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for Dictionary

type Item = (String, Object)

The type of the elements being iterated over.

type IntoIter = DictIterator

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Dictionary as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for Dictionary

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Poppable for Dictionary

unsafe fn pop(lstate: *mut State) -> Result<Dictionary, Error>

Pops the value at the top of the stack.

impl Pushable for Dictionary

unsafe fn push(self, lstate: *mut State) -> Result<i32, Error>

Pushes all its values on the Lua stack, returning the number of values that it pushed.

impl TryFrom<Dictionary> for GotMode

type Error = Error

The type returned in the event of a conversion error.

fn try_from( dict: Dictionary, ) -> Result<GotMode, <GotMode as TryFrom<Dictionary>>::Error>

Performs the conversion.

impl TryFrom<Dictionary> for WinTextHeightInfos

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: Dictionary, ) -> Result<WinTextHeightInfos, <WinTextHeightInfos as TryFrom<Dictionary>>::Error>

Performs the conversion.

impl TryFrom<Object> for Dictionary

type Error = Error

The type returned in the event of a conversion error.

fn try_from( obj: Object, ) -> Result<Dictionary, <Dictionary as TryFrom<Object>>::Error>

Performs the conversion.

impl StructuralPartialEq for Dictionary