Struct Package

pub struct Package {
    pkg: Package,
    version_slated: Option<Version>,
    published_versions: Arc<Mutex<Vec<CratesIoVersion>>>,
    data: Arc<Mutex<PackageData>>,
    metadata: XTaskPackageMetadata,
}

Fields

pkg: Package

version_slated: Option<Version>

published_versions: Arc<Mutex<Vec<CratesIoVersion>>>

data: Arc<Mutex<PackageData>>

metadata: XTaskPackageMetadata

Implementations

impl Package

fn check( &self, packages: &BTreeMap<String, Self>, workspace_root: &Utf8Path, base_branch: Option<&str>, ) -> Result<()>

fn fix( &self, check_run: &CheckRun, workspace_root: &Utf8Path, ) -> Result<Vec<PackageChangeLog>>

fn report( &self, base_package_version: Option<&Version>, package_changes: &mut Vec<String>, errors_markdown: &mut Vec<String>, fragment: Option<&mut Fragment>, ) -> Result<()>

impl Package

const DEFAULT_GIT_RELEASE_BODY: &str = "{% if publish %}\n[<img alt=\"crates.io\" src=\"https://img.shields.io/badge/crates.io-v{{ version }}-orange?labelColor=5C5C5C\" height=\"20\">](https://crates.io/crates/{{ package }}/{{ version }})\n[<img alt=\"docs.rs\" src=\"https://img.shields.io/badge/docs.rs-v{{ version }}-blue?labelColor=5C5C5C\" height=\"20\">](https://docs.rs/{{ package }}/{{ version }})\n{% endif %}\n{{ changelog }}\n"

const DEFAULT_GIT_TAG_NAME: &str = "{{ package }}-v{{ version }}"

pub fn new( workspace_meta: &WorkspaceReleaseMetadata, pkg: Package, ) -> Result<Self>

pub fn should_publish(&self) -> bool

pub fn group(&self) -> &str

pub fn is_dep_public(&self, name: &str) -> bool

pub fn unreleased_req(&self) -> VersionReq

pub fn changelog_path(&self) -> Option<Utf8PathBuf>

pub fn should_git_release(&self) -> bool

pub fn git_release(&self) -> Result<Option<GitRelease>>

pub fn should_semver_checks(&self) -> bool

pub fn should_min_version_check(&self) -> bool

pub fn should_release(&self) -> bool

pub fn last_published_version(&self) -> Option<CratesIoVersion>

pub fn slated_for_release(&self) -> bool

fn git_tag_name(&self) -> Result<String>

fn git_tag_name_version(&self, version: &Version) -> Result<String>

fn git_release_name(&self) -> Result<String>

fn git_release_body(&self) -> Result<String>

pub fn has_branch_changes(&self, base: &str) -> bool

pub fn has_changed_since_publish(&self) -> Result<bool>

pub fn next_version(&self) -> Option<Version>

pub fn set_next_version(&self, version: Version)

pub fn report_change(&self)

pub fn report_breaking_change(&self)

pub fn version_bump(&self) -> Option<VersionBump>

pub fn published_versions(&self) -> Vec<CratesIoVersion>

pub fn fetch_published(&self) -> Result<()>

pub fn report_issue(&self, issue: impl Into<PackageError>)

pub fn set_semver_output(&self, breaking: bool, output: String)

pub fn set_min_versions_output(&self, output: String)

pub fn semver_output(&self) -> Option<(bool, String)>

pub fn min_versions_output(&self) -> Option<String>

pub fn errors(&self) -> Vec<PackageError>

Methods from Deref<Target = Package>

pub fn license_file(&self) -> Option<Utf8PathBuf>

Full path to the license file if one is present in the manifest

pub fn readme(&self) -> Option<Utf8PathBuf>

Full path to the readme file if one is present in the manifest

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for Package

type Target = Package

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.