Struct NamedKeys

pub struct NamedKeys(/* private fields */);

A collection of named keys.

Implementations

impl NamedKeys

pub const fn new() -> Self

Constructs a new, empty NamedKeys.

pub fn into_inner(self) -> BTreeMap<String, Key>

Consumes self, returning the wrapped map.

pub fn insert(&mut self, name: String, key: Key) -> Option<Key>

Inserts a named key.

If the map did not have this name present, None is returned. If the map did have this name present, the Key is updated, and the old Key is returned.

pub fn append(&mut self, other: Self)

Moves all elements from other into self.

pub fn remove(&mut self, name: &str) -> Option<Key>

Removes a named Key, returning the Key if it existed in the collection.

pub fn get(&self, name: &str) -> Option<&Key>

Returns a reference to the Key under the given name if any.

pub fn contains(&self, name: &str) -> bool

Returns true if the named Key exists in the collection.

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

Returns an iterator over the names.

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

Returns an iterator over the Keys (i.e. the map’s values).

pub fn keys_mut(&mut self) -> impl Iterator<Item = &mut Key>

Returns a mutable iterator over the Keys (i.e. the map’s values).

pub fn iter(&self) -> impl Iterator<Item = (&String, &Key)>

Returns an iterator over the name-key pairs.

pub fn len(&self) -> usize

Returns the number of named Keys.

pub fn is_empty(&self) -> bool

Returns true if there are no named Keys.

Trait Implementations

impl CLTyped for NamedKeys

fn cl_type() -> CLType

The CLType of Self.

impl Clone for NamedKeys

fn clone(&self) -> NamedKeys

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSize for NamedKeys

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for NamedKeys

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

Formats the value using the given formatter.

impl Default for NamedKeys

fn default() -> NamedKeys

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NamedKeys

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BTreeMap<String, Key>> for NamedKeys

fn from(value: BTreeMap<String, Key>) -> Self

Converts to this type from the input type.

impl FromBytes for NamedKeys

fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl JsonSchema for NamedKeys

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for NamedKeys

fn eq(&self, other: &NamedKeys) -> 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 Serialize for NamedKeys

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToBytes for NamedKeys

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

impl Eq for NamedKeys

impl StructuralPartialEq for NamedKeys