Struct ValueKey 

pub struct ValueKey<'a>(/* private fields */);

A key for looking up elements in Value arrays and maps.

ValueKey is the parameter type of Value::get, Value::get_mut, Value::remove, and the Index/IndexMut implementations on Value. You rarely name it directly: every type that implements Into<ValueKey> can be passed in, including integers, &str, &[u8], and &Value.

Lookups are zero-copy. Passing &str or &[u8] does not allocate a full Value to compare against map keys.

Examples

use cbor_core::{Value, array, map};

let a = array![10, 20, 30];
assert_eq!(a.get(1).unwrap().to_u32().unwrap(), 20);

let m = map! { "x" => 10, 2 => 20 };
assert_eq!(m.get("x").unwrap().to_u32().unwrap(), 10);
assert_eq!(m.get(2).unwrap().to_u32().unwrap(), 20);

let mut v = array![1, 2, 3];
v.remove(0);
assert_eq!(v.len(), Some(2));

Trait Implementations

impl<'a> From<&'a [u8]> for ValueKey<'a>

fn from(value: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Box<[u8]>> for ValueKey<'a>

fn from(value: &'a Box<[u8]>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Box<str>> for ValueKey<'a>

fn from(value: &'a Box<str>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a String> for ValueKey<'a>

fn from(value: &'a String) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Value> for ValueKey<'a>

fn from(value: &'a Value) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Vec<u8>> for ValueKey<'a>

fn from(value: &'a Vec<u8>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for ValueKey<'a>

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<Box<[u8]>> for ValueKey<'a>

fn from(value: Box<[u8]>) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<Box<str>> for ValueKey<'a>

fn from(value: Box<str>) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<Float> for ValueKey<'a>

fn from(value: Float) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<SimpleValue> for ValueKey<'a>

fn from(value: SimpleValue) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<String> for ValueKey<'a>

fn from(value: String) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<Value> for ValueKey<'a>

fn from(value: Value) -> Self

Converts to this type from the input type.

impl<'a> From<Vec<u8>> for ValueKey<'a>

fn from(value: Vec<u8>) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<bool> for ValueKey<'a>

fn from(value: bool) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<f32> for ValueKey<'a>

fn from(value: f32) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<f64> for ValueKey<'a>

fn from(value: f64) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<i128> for ValueKey<'a>

fn from(value: i128) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<i16> for ValueKey<'a>

fn from(value: i16) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<i32> for ValueKey<'a>

fn from(value: i32) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<i64> for ValueKey<'a>

fn from(value: i64) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<i8> for ValueKey<'a>

fn from(value: i8) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<isize> for ValueKey<'a>

fn from(value: isize) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<u128> for ValueKey<'a>

fn from(value: u128) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<u16> for ValueKey<'a>

fn from(value: u16) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<u32> for ValueKey<'a>

fn from(value: u32) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<u64> for ValueKey<'a>

fn from(value: u64) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<u8> for ValueKey<'a>

fn from(value: u8) -> ValueKey<'a>

Converts to this type from the input type.

impl<'a> From<usize> for ValueKey<'a>

fn from(value: usize) -> ValueKey<'a>

Converts to this type from the input type.

impl Ord for ValueKey<'_>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ValueKey<'_>

fn eq(&self, other: &Self) -> 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 PartialOrd for ValueKey<'_>

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ValueKey<'_>