Struct OptDepend

pub struct OptDepend {
    name: Name,
    description: Option<String>,
}

An optional dependency for a package.

This type is used for representing dependencies that are not essential for base functionality of a package, but may be necessary to make use of certain features of a package.

An OptDepend consists of a name and an optional description separated by a colon (:).

• The name component must be a valid Name.
• If a description is provided it must be at least one character long.

Note

It’s currently not possible to specify a version in an optional dependency due to the limitations of the current file format.

Examples

use std::str::FromStr;

use alpm_types::{Name, OptDepend};

// Create OptDepend from &str
let opt_depend = OptDepend::from_str("example: this is an example dependency")?;

// Get the name
assert_eq!("example", opt_depend.name().as_ref());

// Get the description
assert_eq!(
    Some("this is an example dependency"),
    opt_depend.description().as_deref()
);

// Format as String
assert_eq!(
    "example: this is an example dependency",
    format!("{opt_depend}")
);

Fields

name: Name

description: Option<String>

Implementations

impl OptDepend

pub fn new(name: Name, description: Option<String>) -> OptDepend

Create a new OptDepend in a Result

pub fn name(&self) -> &Name

Return the name of the optional dependency

pub fn description(&self) -> &Option<String>

Return the description for the optional dependency, if it exists

Trait Implementations

impl Clone for OptDepend

fn clone(&self) -> OptDepend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptDepend

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

Formats the value using the given formatter.

impl Display for OptDepend

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

Formats the value using the given formatter.

impl FromStr for OptDepend

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

Create an OptDepend from a string slice

type Err = Error

The associated error which can be returned from parsing.

impl Ord for OptDepend

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

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

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

impl StructuralPartialEq for OptDepend