Struct scarb::core::PackageName

pub struct PackageName(_);

A String-like type representing Package name.

• Instances of this type are validated upon construction to comply with the package naming rules.
• Values are immutable.
• Clone is O(1).
• Short names (which is common for package names) are stack-allocated.

Package naming rules are described in Scarb docs.

Implementations

impl PackageName

pub const CORE: Self = _

pub const STARKNET: Self = _

pub fn new(name: impl AsRef<str>) -> Self

Constructs and validates new PackageName.

Panics if name does not conform to package naming rules.

pub fn try_new(name: impl AsRef<str>) -> Result<Self>

Constructs and validates new PackageName.

pub unsafe fn new_unchecked(name: impl AsRef<str>) -> Self

Constructs new PackageName without validating it to conform to package naming rules.

Safety

1. Does not validate name to conform package naming rules.

pub fn as_str(&self) -> &str

pub fn to_smol_str(&self) -> SmolStr

Trait Implementations

impl AsRef<str> for PackageName

fn as_ref(&self) -> &str

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

impl Borrow<str> for PackageName

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for PackageName

fn clone(&self) -> PackageName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackageName

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

Deserialize this value from the given Serde deserializer.

impl Display for PackageName

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

Formats the value using the given formatter.

impl From<PackageName> for SmolStr

fn from(value: PackageName) -> Self

Converts to this type from the input type.

impl From<PackageName> for String

fn from(value: PackageName) -> Self

Converts to this type from the input type.

impl FromStr for PackageName

type Err = Error

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<Self>

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

impl Hash for PackageName

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 PackageName

fn cmp(&self, other: &PackageName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<PackageName> for PackageName

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

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

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 PackageName

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SmolStr> for PackageName

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: SmolStr) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for PackageName

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for PackageName

impl StructuralEq for PackageName

impl StructuralPartialEq for PackageName