Struct compose_spec::Identifier

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

Validated identifier for use as a map key in a Compose file.

Used to identify top-level items like services, networks, and volumes.

Identifiers must not be empty, start with an ASCII letter (a-z, A-Z) or digit (0-9), and only contain ASCII letters (a-z, A-Z), digits (0-9), dots (.), underscores (_), or dashes (-).

Implementations

impl Identifier

pub fn new<T>(identifier: T) -> Result<Self, InvalidIdentifierError>

where T: AsRef<str> + Into<Box<str>>,

Create a new Identifier, validating the given string.

Errors

Returns an error if the given string is not a valid Identifier. Identifiers must not be empty, start with an ASCII letter (a-z, A-Z) or digit (0-9), and only contain ASCII letters (a-z, A-Z), digits (0-9), dots (.), underscores (_), or dashes (-).

impl Identifier

pub fn as_str(&self) -> &str

A string slice of the inner value.

Convenience method for as_ref() to a &str.

Trait Implementations

impl AsRef<str> for Identifier

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for Identifier

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Identifier

fn clone(&self) -> Identifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Identifier

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

Formats the value using the given formatter.

impl<'_de> Deserialize<'_de> for Identifier

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'_de>,

Deserialize this value from the given Serde deserializer.

impl Display for Identifier

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

Formats the value using the given formatter.

impl From<Identifier> for Box<str>

fn from(value: Identifier) -> Self

Converts to this type from the input type.

impl From<Identifier> for ConfigOrSecret

fn from(source: Identifier) -> Self

Converts to this type from the input type.

impl From<Identifier> for Link

fn from(service: Identifier) -> Self

Converts to this type from the input type.

impl<L> From<Identifier> for ShortOrLong<Identifier, L>

fn from(value: Identifier) -> Self

Converts to this type from the input type.

impl From<Identifier> for Source

fn from(value: Identifier) -> Self

Converts to this type from the input type.

impl From<Identifier> for String

fn from(value: Identifier) -> Self

Converts to this type from the input type.

impl FromStr for Identifier

type Err = InvalidIdentifierError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Identifier

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Identifier

fn cmp(&self, other: &Identifier) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<&str> for Identifier

fn eq(&self, other: &&str) -> 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 PartialEq<str> for Identifier

fn eq(&self, other: &str) -> 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 PartialEq for Identifier

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Identifier

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Identifier

type Error = InvalidIdentifierError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Box<str>> for Identifier

type Error = InvalidIdentifierError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Cow<'_, str>> for Identifier

type Error = InvalidIdentifierError

The type returned in the event of a conversion error.

fn try_from(value: Cow<'_, str>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Identifier

type Error = InvalidIdentifierError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Identifier

impl StructuralPartialEq for Identifier