Enum RequestedVersion

pub enum RequestedVersion {
    Any,
    MajorOnly(ComponentSize),
    Exact(ComponentSize, ComponentSize),
}

The version of Python being searched for.

The constraints of what is being searched for can very from being open-ended/broad (i.e. RequestedVersion::Any) to as specific as major.minor (e.g. RequestedVersion::Exact to search for Python 3.10).

Variants

Any

Any version of Python is acceptable.

MajorOnly(ComponentSize)

A major version of Python is required (e.g. 3.x).

Exact(ComponentSize, ComponentSize)

A specific major.minor version of Python is required (e.g. 3.9).

Implementations

impl RequestedVersion

pub fn env_var(self) -> Option<String>

Returns the String representing the environment variable for the requested version (if applicable).

Examples

Searching for RequestedVersion::Any provides an environment variable which can be used to specify the default version of Python to use (e.g. 3.10).

let any_version = python_launcher::RequestedVersion::Any;

assert_eq!(Some("PY_PYTHON".to_string()), any_version.env_var());

RequestedVersion::MajorOnly uses an environment variable which is scoped to providing the default version for when the major version is only specified.

let major_version = python_launcher::RequestedVersion::MajorOnly(3);

assert_eq!(Some("PY_PYTHON3".to_string()), major_version.env_var());

When RequestedVersion::Exact is specified, there is no “default” to provide/interpreter, and so no environment variable exists.

let exact_version = python_launcher::RequestedVersion::Exact(3, 10);

assert!(exact_version.env_var().is_none());

Trait Implementations

impl Clone for RequestedVersion

fn clone(&self) -> RequestedVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RequestedVersion

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

Formats the value using the given formatter.

impl Display for RequestedVersion

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

Format to a readable name of the Python version requested, e.g. Python 3.9.

impl From<ExactVersion> for RequestedVersion

fn from(version: ExactVersion) -> Self

Converts to this type from the input type.

impl FromStr for RequestedVersion

type Err = Error

The associated error which can be returned from parsing.

fn from_str(version_string: &str) -> Result<Self>

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

impl Hash for RequestedVersion

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 PartialEq for RequestedVersion

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

impl Eq for RequestedVersion

impl StructuralPartialEq for RequestedVersion