Struct compose_spec::Name

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

Validated Compose project name.

Names cannot be empty, they must start with a lowercase ASCII letter (a-z) or digit (0-9), and must only contain lowercase ASCII letters (a-z), digits (0-9), underscores (_), or dashes (-).

compose-spec

Implementations

impl Name

pub fn new<T>(name: T) -> Result<Self, InvalidNameError>

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

Create a new Name, validating the given string.

Errors

Returns an error if the given string is not a valid Name. Names cannot be empty, they must start with a lowercase ASCII letter (a-z) or digit (0-9), and must only contain lowercase ASCII letters (a-z), digits (0-9), underscores (_), or dashes (-).

pub fn as_str(&self) -> &str

Name as a string slice.

Convenience method for as_ref() to a &str.

Trait Implementations

impl AsRef<str> for Name

fn as_ref(&self) -> &str

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

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl<'_de> Deserialize<'_de> for Name

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

where D: Deserializer<'_de>,

Deserialize this value from the given Serde deserializer.

impl Display for Name

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

Formats the value using the given formatter.

impl From<Name> for Box<str>

fn from(value: Name) -> Self

Converts to this type from the input type.

impl From<Name> for String

fn from(value: Name) -> Self

Converts to this type from the input type.

impl FromStr for Name

type Err = InvalidNameError

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 Ord for Name

fn cmp(&self, other: &Name) -> 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 for Name

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

fn partial_cmp(&self, other: &Name) -> 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 Name

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 Name

type Error = InvalidNameError

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 Name

type Error = InvalidNameError

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<String> for Name

type Error = InvalidNameError

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 Name

impl StructuralPartialEq for Name