Struct PythonModuleName 

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

Implementations

impl PythonModuleName

pub fn new(input: &str) -> Result<Self, PythonModuleNameError>

Creates lightly validated dotted Python name metadata.

Errors

Returns PythonModuleNameError when input is empty, has empty segments, or contains invalid identifier segments.

Examples found in repository

examples/basic_usage.rs (line 4)

fn main() -> Result<(), use_python_module::PythonModuleNameError> {
    let module = PythonModuleName::new("package.submodule")?;

    assert_eq!(module.segments(), vec!["package", "submodule"]);
    assert_eq!(PythonImportKind::Absolute.as_str(), "absolute");
    Ok(())
}

pub fn as_str(&self) -> &str

Returns the dotted name.

pub fn segments(&self) -> Vec<&str>

Returns the dotted name segments.

Examples found in repository

examples/basic_usage.rs (line 6)

fn main() -> Result<(), use_python_module::PythonModuleNameError> {
    let module = PythonModuleName::new("package.submodule")?;

    assert_eq!(module.segments(), vec!["package", "submodule"]);
    assert_eq!(PythonImportKind::Absolute.as_str(), "absolute");
    Ok(())
}

Trait Implementations

impl Clone for PythonModuleName

fn clone(&self) -> PythonModuleName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PythonModuleName

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

Formats the value using the given formatter.

impl Display for PythonModuleName

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

Formats the value using the given formatter.

impl FromStr for PythonModuleName

type Err = PythonModuleNameError

The associated error which can be returned from parsing.

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

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

impl Hash for PythonModuleName

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 PythonModuleName

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

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

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

type Error = PythonModuleNameError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for PythonModuleName

impl StructuralPartialEq for PythonModuleName