Struct fiberplane_models::labels::Label

#[non_exhaustive]
pub struct Label {
    pub key: String,
    pub value: String,
}

Labels that are associated with a Notebook.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: String

The key of the label. Should be unique for a single Notebook.

value: String

The value of the label. Can be left empty.

Implementations

impl Label

pub fn builder() -> LabelBuilder<((), ())>

Create a builder for building Label. On the builder, call .key(...), .value(...) to set the values of the fields. Finally, call .build() to create the instance of Label.

impl Label

pub fn new(key: impl Into<String>, value: impl Into<String>) -> Self

pub fn validate(&self) -> Result<(), LabelValidationError>

Validates the key and value.

pub fn validate_key(key: &str) -> Result<(), LabelValidationError>

A key is considered valid if it adheres to the following criteria: It can contain two segments, a prefix and a name, the name segment has the following criteria:

• must be 63 characters or less (cannot be empty)
• must begin and end with an alphanumeric character ([a-z0-9A-Z])
• could contain dashes (-), underscores (_), dots (.), and alphanumerics between

The prefix is optional, if specified must follow the following criteria:

• must be 253 characters or less
• must be a valid DNS subdomain

pub fn validate_value(value: &str) -> Result<(), LabelValidationError>

A value is considered valid if it adheres to the following criteria:

• must be 63 characters or less (can be empty)
• unless empty, must begin and end with an alphanumeric character ([a-z0-9A-Z])
• could contain dashes (-), underscores (_), dots (.), and alphanumerics between

Trait Implementations

impl Clone for Label

fn clone(&self) -> Label

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Label

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Label

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

Deserialize this value from the given Serde deserializer.

impl Display for Label

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

Formats the value using the given formatter.

impl PartialEq<Label> for Label

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

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

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

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

impl Serialize for Label

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

Serialize this value into the given Serde serializer.

impl Eq for Label

impl StructuralEq for Label

impl StructuralPartialEq for Label