Skip to main content

Labels

Struct Labels 

Source
pub struct Labels(/* private fields */);
Expand description

Structured key-value metadata based on BTreeMap.

Iteration order is stable because labels are stored in key order.

§Example

use solti_model::Labels;

let mut labels = Labels::new();
labels.insert("zone", "eu");
labels.insert("gpu", "h100");

assert_eq!(labels.get("zone"), Some("eu"));
assert!(labels.contains_key("gpu"));

Implementations§

Source§

impl Labels

Source

pub fn new() -> Self

Creates an empty label map.

§Example
use solti_model::Labels;

let labels = Labels::new();
assert!(labels.is_empty());
Source

pub fn len(&self) -> usize

Returns the number of labels.

Source

pub fn is_empty(&self) -> bool

Returns whether the map is empty.

Source

pub fn insert<K, V>(&mut self, key: K, val: V) -> &mut Self
where K: Into<String>, V: Into<String>,

Inserts or replaces a label.

§Example
use solti_model::Labels;

let mut labels = Labels::new();
labels.insert("tier", "dev").insert("tier", "prod");

assert_eq!(labels.get("tier"), Some("prod"));
Source

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

Returns the value for a key.

Source

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

Returns whether a key exists.

Source

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

Iterates over labels in key order.

§Example
use solti_model::Labels;

let mut labels = Labels::new();
labels.insert("b", "2");
labels.insert("a", "1");

let pairs: Vec<_> = labels.iter().collect();
assert_eq!(pairs, vec![("a", "1"), ("b", "2")]);
Source

pub fn validate(&self) -> ModelResult<()>

Validates every label.

§Errors

Returns crate::ModelError::Invalid.

Trait Implementations§

Source§

impl Clone for Labels

Source§

fn clone(&self) -> Labels

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Labels

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Labels

Source§

fn default() -> Labels

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Labels

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Labels

Source§

impl<'a> IntoIterator for &'a Labels

Source§

type Item = (&'a str, &'a str)

The type of the elements being iterated over.
Source§

type IntoIter = LabelsIter<'a>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl JsonSchema for Labels

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for Labels

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Labels

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Labels

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.