Struct Name 

pub struct Name(String);

A package name

Package names may contain the characters [a-zA-Z0-9\-._@+], but must not start with [-.] (see alpm-package-name).

Examples

use std::str::FromStr;

use alpm_types::{Error, Name};

// create Name from &str
assert_eq!(
    Name::from_str("test-123@.foo_+"),
    Ok(Name::new("test-123@.foo_+")?)
);
assert!(Name::from_str(".test").is_err());

// format as String
assert_eq!("foo", format!("{}", Name::new("foo")?));

Tuple Fields

0: String

Implementations

impl Name

const SPECIAL_FIRST_CHARS: [char; 3]

The subset of special characters that are allowed as first character of a Name.

const NEVER_FIRST_CHAR: [char; 5]

The set of characters allowed anywhere in a Name, except as first character.

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

Create a new Name

pub fn inner(&self) -> &str

Return a reference to the inner type

impl Name

pub(crate) fn parse_name_followed_by_version<'a>( delimiter_count: usize, ) -> impl Parser<&'a str, Self, ErrMode<ContextError>>

Recognizes a Name as part of an InstalledPackage.

Warning

This parser is designed specifically for the internal InstalledPackage parser.

InstalledPackage is a very special use-case, as it uses dashes (-) as delimiter. However, dashes are also valid characters in a Name. As such, the Name parser must be aware of how many dashes are expected to be inside the input string to parse.

This is a necessary, albeit cursed hack due to InstalledPackage’s dash-based delimiter design.

In contrast to Name::parser, this function expects the final character to be a -, which it does not consume.

Errors

Returns an error if input does not begin with a valid alpm-package-name.

Trait Implementations

impl AlpmParser for Name

fn parser(input: &mut &str) -> ModalResult<Self>

Recognizes a Name in a string slice.

Errors

Returns an error if input does not begin with a [alpm-package-name].

fn delimiter_error_context<'a, O, P>( parser: P, ) -> impl Parser<&'a str, O, ErrMode<ContextError>>

where P: Parser<&'a str, O, ErrMode<ContextError>>,

Attaches a winnow error context to the parser when a parse error is encountered.

impl AsRef<str> for Name

fn as_ref(&self) -> &str

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

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Name

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Name

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

Formats the value using the given formatter.

impl FromStr for Name

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

Creates a Name from a string slice.

Delegates to Name::parser.

Errors

Returns an error if Name::parser fails.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Name

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 Name

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Name

impl StructuralPartialEq for Name