Struct PyProjectProjectMetadata 

pub struct PyProjectProjectMetadata { /* private fields */ }

Partial [project] metadata.

Implementations

impl PyProjectProjectMetadata

pub const fn new() -> Self

Creates empty project metadata.

Examples found in repository

examples/basic_usage.rs (line 4)

fn main() -> Result<(), use_pyproject::PyProjectTextError> {
    let project = PyProjectProjectMetadata::new()
        .with_name("demo")?
        .with_version("0.1.0")?
        .with_dependency(PyProjectDependency::new("requests>=2")?);
    let pyproject = PyProject::new().with_project(project);

    assert_eq!(pyproject.project_name(), Some("demo"));
    assert_eq!(pyproject.dependencies()[0].as_str(), "requests>=2");
    Ok(())
}

pub fn with_name(self, name: &str) -> Result<Self, PyProjectTextError>

Sets the project name.

Errors

Returns PyProjectTextError::Empty when name is empty after trimming.

Examples found in repository

examples/basic_usage.rs (line 5)

fn main() -> Result<(), use_pyproject::PyProjectTextError> {
    let project = PyProjectProjectMetadata::new()
        .with_name("demo")?
        .with_version("0.1.0")?
        .with_dependency(PyProjectDependency::new("requests>=2")?);
    let pyproject = PyProject::new().with_project(project);

    assert_eq!(pyproject.project_name(), Some("demo"));
    assert_eq!(pyproject.dependencies()[0].as_str(), "requests>=2");
    Ok(())
}

pub fn with_version(self, version: &str) -> Result<Self, PyProjectTextError>

Sets the project version.

Errors

Returns PyProjectTextError::Empty when version is empty after trimming.

Examples found in repository

examples/basic_usage.rs (line 6)

fn main() -> Result<(), use_pyproject::PyProjectTextError> {
    let project = PyProjectProjectMetadata::new()
        .with_name("demo")?
        .with_version("0.1.0")?
        .with_dependency(PyProjectDependency::new("requests>=2")?);
    let pyproject = PyProject::new().with_project(project);

    assert_eq!(pyproject.project_name(), Some("demo"));
    assert_eq!(pyproject.dependencies()[0].as_str(), "requests>=2");
    Ok(())
}

pub fn with_dependency(self, dependency: PyProjectDependency) -> Self

Adds a dependency.

Examples found in repository

examples/basic_usage.rs (line 7)

fn main() -> Result<(), use_pyproject::PyProjectTextError> {
    let project = PyProjectProjectMetadata::new()
        .with_name("demo")?
        .with_version("0.1.0")?
        .with_dependency(PyProjectDependency::new("requests>=2")?);
    let pyproject = PyProject::new().with_project(project);

    assert_eq!(pyproject.project_name(), Some("demo"));
    assert_eq!(pyproject.dependencies()[0].as_str(), "requests>=2");
    Ok(())
}

pub fn with_optional_dependency_group( self, group: PyProjectOptionalDependencyGroup, ) -> Self

Adds an optional dependency group label.

pub fn with_script(self, script: PyProjectScript) -> Self

Adds a script label.

pub fn with_entry_point(self, entry_point: PyProjectEntryPoint) -> Self

Adds an entry point label.

pub fn name(&self) -> Option<&str>

Returns the project name when present.

pub fn version(&self) -> Option<&str>

Returns the project version when present.

pub fn dependencies(&self) -> &[PyProjectDependency]

Returns dependencies.

pub fn optional_dependency_groups(&self) -> &[PyProjectOptionalDependencyGroup]

Returns optional dependency group labels.

pub fn scripts(&self) -> &[PyProjectScript]

Returns script labels.

pub fn entry_points(&self) -> &[PyProjectEntryPoint]

Returns entry point labels.

Trait Implementations

impl Clone for PyProjectProjectMetadata

fn clone(&self) -> PyProjectProjectMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyProjectProjectMetadata

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

Formats the value using the given formatter.

impl Default for PyProjectProjectMetadata

fn default() -> PyProjectProjectMetadata

Returns the “default value” for a type.

impl PartialEq for PyProjectProjectMetadata

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

impl StructuralPartialEq for PyProjectProjectMetadata