Struct StorePathNameBuf 

pub struct StorePathNameBuf(SmolStr);

An owned validated name of a store path.

The name may only contain ASCII alphanumeric, or one of the following characters: -, _, ., +, ?, = and must be shorter than 211 characters long.

Tuple Fields

0: SmolStr

Implementations

impl StorePathNameBuf

pub const fn max_len() -> usize

Maximum number of bytes in a store path name.

pub fn source() -> StorePathNameBuf

Return default name of sources.

Examples

assert_eq!(StorePathNameBuf::source(), "source");

pub fn from_string(name: String) -> Result<Self, ParseStorePathNameError>

Checks a given String to match the restrictions for store path names, and returns the name as StorePathNameBuf if successful.

pub fn from_smol_str(name: SmolStr) -> Result<Self, ParseStorePathNameError>

Checks a given SmolStr to match the restrictions for store path names, and returns the name as StorePathNameBuf if successful.

pub fn from_slice(name: &[u8]) -> Result<Self, ParseStorePathNameError>

Checks a given &[u8] to match the restrictions for store path names, and returns the name as StorePathNameBuf if successful.

pub fn as_name(&self) -> &StorePathName

Coerces to a StorePathName slice.

Examples

let name = StorePathNameBuf::try_from("snix-build").unwrap();
assert_eq!(StorePathName::from_str("snix-build").unwrap(), name.as_name());

Methods from Deref<Target = StorePathName>

pub fn build_drv_name( &self, ) -> Result<StorePathNameBuf, ParseStorePathNameError>

Build a new StorePathNameBuf by adding .drv extension to this StorePathName. This fails if this name already ends in .drv or the resulting name would be too long.

Examples

let n = StorePathName::from_str("snix-eval").unwrap();
assert_eq!(n.build_drv_name().unwrap(), "snix-eval.drv");

pub fn is_drv(&self) -> bool

Returns true if this is the name of a derivation.

Derivation names always end in .drv and has len() longer than 4.

Examples

let n = StorePathName::from_str("snix-eval").unwrap();
assert!(!n.is_drv());

let b = n.build_drv_name().unwrap();
assert!(b.is_drv());

pub fn strip_drv_ext(&self) -> Option<&StorePathName>

Remove .drv extension from this name or return None if this is not a derivation name.

pub fn strip_suffix(&self, suffix: &str) -> Option<&StorePathName>

Strip a suffix from this name or return None if the resulting name would have been empty.

pub fn len(&self) -> usize

Returns the length of this name.

Examples

assert_eq!(6, StorePathName::source().len());

pub fn as_str(&self) -> &str

Converts a name to a string. To convert the string back into a name, use the Self::from_str function.

Examples

let s = StorePathName::source().as_str();
assert_eq!("source", s);

pub fn as_bytes(&self) -> &[u8]

Converts a name to a byte slice. To convert the byte slice back into a name, use the Self::from_slice function.

Examples

let bytes = StorePathName::source().as_bytes();
assert_eq!(b"source", bytes);

Trait Implementations

impl AsRef<StorePathName> for StorePathNameBuf

fn as_ref(&self) -> &StorePathName

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

impl AsRef<str> for StorePathNameBuf

fn as_ref(&self) -> &str

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

impl Borrow<StorePathName> for StorePathNameBuf

fn borrow(&self) -> &StorePathName

Immutably borrows from an owned value.

impl Clone for StorePathNameBuf

fn clone(&self) -> StorePathNameBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorePathNameBuf

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

Formats the value using the given formatter.

impl Default for StorePathNameBuf

fn default() -> Self

Returns the “default value” for a type.

impl Deref for StorePathNameBuf

type Target = StorePathName

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for StorePathNameBuf

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

Formats the value using the given formatter.

impl<'a> From<&'a StorePathName> for StorePathNameBuf

fn from(value: &'a StorePathName) -> Self

Converts to this type from the input type.

impl FromStr for StorePathNameBuf

type Err = ParseStorePathNameError

The associated error which can be returned from parsing.

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

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

impl Hash for StorePathNameBuf

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 PartialEq<&StorePathName> for StorePathNameBuf

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

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

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

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

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

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

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

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

fn eq(&self, other: &StorePathNameBuf) -> 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 TryFrom<&[u8]> for StorePathNameBuf

type Error = ParseStorePathNameError

The type returned in the event of a conversion error.

fn try_from(name: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for StorePathNameBuf

type Error = ParseStorePathNameError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SmolStr> for StorePathNameBuf

type Error = ParseStorePathNameError

The type returned in the event of a conversion error.

fn try_from(name: SmolStr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for StorePathNameBuf

type Error = ParseStorePathNameError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for StorePathNameBuf

impl StructuralPartialEq for StorePathNameBuf