Struct PackageName

pub struct PackageName<T: AsRef<str> = String>(T);

Verified string newtype

Tuple Fields

0: T

Implementations

impl<T: AsRef<str>> PackageName<T>

pub fn into_inner(self) -> T

impl<T: AsRef<str>> PackageName<T>

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

Validated package name

impl PackageName

pub fn sanitize(name: impl AsRef<str>, placeholder: char) -> Self

Coerce a value to be a validate package name

Replaces invalid values with placeholder

Trait Implementations

impl<T: AsRef<str>> AsRef<str> for PackageName<T>

fn as_ref(&self) -> &str

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

impl<T: AsRef<str>> Borrow<str> for PackageName<T>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<T: Clone + AsRef<str>> Clone for PackageName<T>

fn clone(&self) -> PackageName<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + AsRef<str>> Debug for PackageName<T>

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

Formats the value using the given formatter.

impl<T: AsRef<str>> Deref for PackageName<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, T: AsRef<str> + Deserialize<'de>> Deserialize<'de> for PackageName<T>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: AsRef<str>> Display for PackageName<T>

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

Formats the value using the given formatter.

impl<'a> FromStr for PackageName<String>

type Err = NameValidationError

The associated error which can be returned from parsing.

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

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

impl<T: Hash + AsRef<str>> Hash for PackageName<T>

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<T: Ord + AsRef<str>> Ord for PackageName<T>

fn cmp(&self, other: &PackageName<T>) -> 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<T: PartialEq + AsRef<str>> PartialEq for PackageName<T>

fn eq(&self, other: &PackageName<T>) -> 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<T: PartialOrd + AsRef<str>> PartialOrd for PackageName<T>

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

where T: Serialize + AsRef<str>,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq + AsRef<str>> Eq for PackageName<T>

impl<T: AsRef<str>> StructuralPartialEq for PackageName<T>

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.