Struct BuildTool

pub struct BuildTool(Name);

A build tool name

The same character restrictions as with Name apply. Further name restrictions may be enforced on an existing instances using matches_restriction().

Examples

use std::str::FromStr;

use alpm_types::{BuildTool, Error, Name};

// create BuildTool from &str
assert!(BuildTool::from_str("test-123@.foo_+").is_ok());
assert!(BuildTool::from_str(".test").is_err());

// format as String
assert_eq!("foo", format!("{}", BuildTool::from_str("foo").unwrap()));

// validate that BuildTool follows naming restrictions
let buildtool = BuildTool::from_str("foo").unwrap();
let restrictions = vec![
    Name::from_str("foo").unwrap(),
    Name::from_str("bar").unwrap(),
];
assert!(buildtool.matches_restriction(&restrictions));

Tuple Fields

0: Name

Implementations

impl BuildTool

pub fn new(name: Name) -> Self

Create a new BuildTool

pub fn new_with_restriction( name: &str, restrictions: &[Name], ) -> Result<Self, Error>

Create a new BuildTool in a Result, which matches one Name in a list of restrictions

Examples

use alpm_types::{BuildTool, Error, Name};

assert!(
    BuildTool::new_with_restriction("foo", &[Name::new("foo".to_string()).unwrap()]).is_ok()
);
assert!(
    BuildTool::new_with_restriction("foo", &[Name::new("bar".to_string()).unwrap()]).is_err()
);

pub fn matches_restriction(&self, restrictions: &[Name]) -> bool

Validate that the BuildTool has a name matching one Name in a list of restrictions

pub fn inner(&self) -> &Name

Return a reference to the inner type

Trait Implementations

impl Clone for BuildTool

fn clone(&self) -> BuildTool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuildTool

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

Formats the value using the given formatter.

impl Display for BuildTool

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

Formats the value using the given formatter.

impl FromStr for BuildTool

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

Create a BuildTool from a string

type Err = Error

The associated error which can be returned from parsing.

impl Ord for BuildTool

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

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

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

impl StructuralPartialEq for BuildTool