Struct Requirement 

pub struct Requirement {
    pub name: PackageName,
    pub extras: Box<[ExtraName]>,
    pub groups: Box<[GroupName]>,
    pub marker: MarkerTree,
    pub source: RequirementSource,
    pub origin: Option<RequirementOrigin>,
}

A representation of dependency on a package, an extension over a PEP 508’s requirement.

The main change is using RequirementSource to represent all supported package sources over VersionOrUrl, which collapses all URL sources into a single stringly type.

Additionally, this requirement type makes room for dependency groups, which lack a standardized representation in PEP 508. In the context of this type, extras and groups are assumed to be mutually exclusive, in that if extras is non-empty, groups must be empty and vice versa.

Fields

name: PackageName

extras: Box<[ExtraName]>

groups: Box<[GroupName]>

marker: MarkerTree

source: RequirementSource

origin: Option<RequirementOrigin>

Implementations

impl Requirement

pub fn evaluate_markers( &self, env: Option<&MarkerEnvironment>, extras: &[ExtraName], ) -> bool

Returns whether the markers apply for the given environment.

When env is None, this specifically evaluates all marker expressions based on the environment to true. That is, this provides environment independent marker evaluation.

pub fn is_editable(&self) -> bool

Returns true if the requirement is editable.

pub fn relative_to(self, path: &Path) -> Result<Self, Error>

Convert to a Requirement with a relative path based on the given root.

pub fn to_absolute(self, path: &Path) -> Self

Convert to a Requirement with an absolute path based on the given root.

pub fn hashes(&self) -> Option<Hashes>

Return the hashes of the requirement, as specified in the URL fragment.

pub fn with_origin(self, origin: RequirementOrigin) -> Self

Set the source file containing the requirement.

Trait Implementations

impl CacheKey for Requirement

fn cache_key(&self, state: &mut CacheKeyHasher)

fn cache_key_slice(data: &[Self], state: &mut CacheKeyHasher)

where Self: Sized,

impl Clone for Requirement

fn clone(&self) -> Requirement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Requirement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Requirement

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Requirement

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

Display the Requirement, with the intention of being shown directly to a user, rather than for inclusion in a requirements.txt file.

impl From<ExtraBuildRequirement> for Requirement

fn from(value: ExtraBuildRequirement) -> Self

Converts to this type from the input type.

impl From<Requirement<VerbatimParsedUrl>> for Requirement

fn from(requirement: Requirement<VerbatimParsedUrl>) -> Self

Convert a uv_pep508::Requirement to a Requirement.

impl From<Requirement> for NameRequirementSpecification

fn from(requirement: Requirement) -> Self

Converts to this type from the input type.

impl From<Requirement> for Requirement<VerbatimUrl>

fn from(requirement: Requirement) -> Self

Convert a Requirement to a uv_pep508::Requirement.

impl From<Requirement> for Requirement<VerbatimParsedUrl>

fn from(requirement: Requirement) -> Self

Convert a Requirement to a uv_pep508::Requirement.

impl From<Requirement> for UnresolvedRequirementSpecification

fn from(requirement: Requirement) -> Self

Converts to this type from the input type.

impl Hash for Requirement

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 Requirement

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

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

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

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 Requirement