Struct PipRequirement 

pub struct PipRequirement(/* private fields */);

Validated pip requirement text.

Implementations

impl PipRequirement

pub fn new(input: &str) -> Result<PipRequirement, PipTextError>

Creates pip requirement metadata.

Errors

Returns PipTextError::Empty when input is empty after trimming.

Examples found in repository

examples/basic_usage.rs (line 9)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let version: PythonVersion = "Python 3.12.1".parse()?;
    let identifier = PythonIdentifier::new("async_task")?;
    let requirement = PipRequirement::new("requests>=2")?;
    let node_id = PytestNodeId::new("tests/test_app.py::test_smoke")?;

    assert!(version.is_python3());
    assert_eq!(identifier.as_str(), "async_task");
    assert_eq!(PythonImplementation::CPython.as_str(), "cpython");
    assert_eq!(PythonPrimitiveValue::None.type_name(), "NoneType");
    assert!(!requirement.is_editable());
    assert!(node_id.has_scope_separator());
    Ok(())
}

pub fn as_str(&self) -> &str

Returns the requirement text.

pub fn is_editable(&self) -> bool

Returns whether the requirement looks like an editable install option.

Examples found in repository

examples/basic_usage.rs (line 16)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let version: PythonVersion = "Python 3.12.1".parse()?;
    let identifier = PythonIdentifier::new("async_task")?;
    let requirement = PipRequirement::new("requests>=2")?;
    let node_id = PytestNodeId::new("tests/test_app.py::test_smoke")?;

    assert!(version.is_python3());
    assert_eq!(identifier.as_str(), "async_task");
    assert_eq!(PythonImplementation::CPython.as_str(), "cpython");
    assert_eq!(PythonPrimitiveValue::None.type_name(), "NoneType");
    assert!(!requirement.is_editable());
    assert!(node_id.has_scope_separator());
    Ok(())
}

pub fn is_requirements_file(&self) -> bool

Returns whether the requirement looks like a requirements-file option.

Trait Implementations

impl Clone for PipRequirement

fn clone(&self) -> PipRequirement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PipRequirement

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

Formats the value using the given formatter.

impl Display for PipRequirement

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

Formats the value using the given formatter.

impl FromStr for PipRequirement

type Err = PipTextError

The associated error which can be returned from parsing.

fn from_str( input: &str, ) -> Result<PipRequirement, <PipRequirement as FromStr>::Err>

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

impl Hash for PipRequirement

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

where __H: Hasher,

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 PipRequirement

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

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

fn partial_cmp(&self, other: &PipRequirement) -> 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 TryFrom<&str> for PipRequirement

type Error = PipTextError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<PipRequirement, <PipRequirement as TryFrom<&str>>::Error>

Performs the conversion.

impl Eq for PipRequirement

impl StructuralPartialEq for PipRequirement