Struct ProfileName 

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

Validated profile name.

Profile names appear in three places: the manifest TOML key ([profile.<name>]), the CLI flag (--profile <name>), and the on-disk build directory layout (<build_dir>/<profile>/...). The grammar below is the intersection of those three constraints so a single value can flow through all of them without per-stage re-validation.

Implementations

impl ProfileName

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

Construct a ProfileName after running validation.

A name is valid iff:

• it is non-empty;
• it consists only of ASCII alphanumerics, _, -, .;
• it does not start with .;
• it is not literally . or ...

Errors

Returns InvalidProfileName when value fails the is_path_safe_profile_name predicate above.

pub fn builtin(profile: BuiltinProfile) -> Self

Construct a ProfileName for one of Cabin’s two built-ins. Built-in names are guaranteed valid so this never fails.

pub fn as_str(&self) -> &str

pub fn as_builtin(&self) -> Option<BuiltinProfile>

Returns the matching BuiltinProfile when this name refers to a built-in.

Trait Implementations

impl AsRef<str> for ProfileName

fn as_ref(&self) -> &str

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

impl Borrow<str> for ProfileName

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for ProfileName

fn clone(&self) -> ProfileName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProfileName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProfileName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProfileName

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

Formats the value using the given formatter.

impl From<ProfileName> for String

fn from(name: ProfileName) -> Self

Converts to this type from the input type.

impl Hash for ProfileName

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 ProfileName

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for ProfileName

type Error = InvalidProfileName

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 ProfileName

impl StructuralPartialEq for ProfileName