Struct Package 

pub struct Package { /* private fields */ }

A package in the workspace.

Implementations

impl Package

pub fn new<S>(name: S) -> Self

where S: Into<String>,

Create a Package with the given name.

This uses the current directory as the the workspace path.

pub fn with_workspace<S, P>(name: S, workspace: P) -> Self

where S: Into<String>, P: Into<PathBuf>,

Create a Package with the given name and workspace.

The workspace directory should be the root of the workspace, or just the directory of the package in non-workspace projects.

pub fn name(&self) -> &str

Get the package’s name.

pub fn workspace(&self) -> &Path

Get the package’s root workspace directory.

pub fn get_git_tag_name(&self, local_version: &str) -> String

Format a package version as a git tag.

pub fn get_local_version(&self) -> Result<String, GetLocalVersionError>

Use cargo metadata to get the local version of a package in the workspace.

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl Hash for Package

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 Package

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

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

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

impl StructuralPartialEq for Package