Struct StorePathName 

#[repr(transparent)]
pub struct StorePathName(str);

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: str

Implementations

impl StorePathName

pub const fn max_len() -> usize

Maximum number of bytes in a store path name.

pub const fn source() -> &'static StorePathName

Return default name of sources.

Examples

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

pub const unsafe fn from_str_unchecked(name: &str) -> &StorePathName

Converts a str to a StorePathName without checking that it is a valid name.

Safety

This function is unsafe because it does not check that the str passed to it is a valid store path name. If this constraint is violated it may cause panics and memory safety issues , as the rest of snix assumes that StorePathName contains a valid store path name.

pub fn from_str(name: &str) -> Result<&StorePathName, ParseStorePathNameError>

Checks a given &str to match the restrictions for StorePathName, and returns the name as &StorePathName if successful.

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

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

pub fn from_os_str( name: &OsStr, ) -> Result<&StorePathName, ParseStorePathNameError>

Checks a given OsStr to match the restrictions for StorePathName, and returns the name as &StorePathName if successful

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 const fn len(&self) -> usize

Returns the length of this name.

Examples

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

pub const 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 const 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<[u8]> for StorePathName

fn as_ref(&self) -> &[u8]

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

impl AsRef<StorePathName> for StorePathName

fn as_ref(&self) -> &StorePathName

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

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 StorePathName

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 Debug for StorePathName

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

Formats the value using the given formatter.

impl Display for StorePathName

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 Hash for StorePathName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value 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 StorePathName

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<StorePathName> for &str

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

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<StorePathName> for str

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

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 StorePathName

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 StorePathName

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 ToOwned for StorePathName

type Owned = StorePathNameBuf

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<'a> TryFrom<&'a [u8]> for &'a StorePathName

type Error = ParseStorePathNameError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a str> for &'a StorePathName

type Error = ParseStorePathNameError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for StorePathName

impl StructuralPartialEq for StorePathName