Struct miau::configuration::CompoundKey

pub struct CompoundKey(_);

Multikey for configuration

Consists of multiple keys

It is used indirectly in many functions reading from configuration. Usually it should not be constructed directly.

Implementations

impl CompoundKey

pub fn new(keys: Vec<Key>) -> Self

Constructs new instance of CompoundKey

Methods from Deref<Target = Vec<Key>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

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

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector's buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn allocator(&self) -> &A

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

Returns a reference to the underlying allocator.

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl Clone for CompoundKey

pub fn clone(&self) -> CompoundKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompoundKey

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

Formats the value using the given formatter.

impl Deref for CompoundKey

type Target = Vec<Key>

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for CompoundKey

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

Deserialize this value from the given Serde deserializer.

impl Eq for CompoundKey

impl From<Vec<Key, Global>> for CompoundKey

pub fn from(keys: Vec<Key>) -> Self

Performs the conversion.

impl Hash for CompoundKey

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<CompoundKey> for CompoundKey

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

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

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

This method tests for !=.

impl Serialize for CompoundKey

pub 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 CompoundKey

impl StructuralPartialEq for CompoundKey

impl<'_> TryFrom<&'_ str> for CompoundKey

type Error = ConfigurationError

The type returned in the event of a conversion error.

pub fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for CompoundKey

type Error = ConfigurationError

The type returned in the event of a conversion error.

pub fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.