Enum crates_index_diff::Change

pub enum Change {
    Added(CrateVersion),
    Unyanked(CrateVersion),
    AddedAndYanked(CrateVersion),
    Yanked(CrateVersion),
    CrateDeleted {
        name: String,
        versions: Vec<CrateVersion>,
    },
    VersionDeleted(CrateVersion),
}

Identify a kind of change that occurred to a crate

Variants

Added(CrateVersion)

A crate version was added.

Unyanked(CrateVersion)

A crate version was unyanked.

AddedAndYanked(CrateVersion)

A crate version was added in a yanked state.

This can happen if we don’t see the commit that added them, so it appears to pop into existence yanked. Knowing this should help to trigger the correct action, as simply Yanked crates would be treated quite differently.

Yanked(CrateVersion)

A crate version was yanked.

CrateDeleted

The name of the crate whose file was deleted, which implies all versions were deleted as well.

Fields

name: String

The name of the deleted crate.

versions: Vec<CrateVersion>

All of its versions that were deleted along with the file.

VersionDeleted(CrateVersion)

A crate version was deleted.

Note that this is equivalent to deleting a line from a crates version file. Should more than one lines be removed per commit, the order of these changes is nondeterministic.

Implementations

impl Change

pub fn added(&self) -> Option<&CrateVersion>

Return the added crate, if this is this kind of change.

pub fn yanked(&self) -> Option<&CrateVersion>

Return the yanked crate, if this is this kind of change.

pub fn unyanked(&self) -> Option<&CrateVersion>

Return the unyanked crate, if this is this kind of change.

pub fn crate_deleted(&self) -> Option<(&str, &[CrateVersion])>

Return the deleted crate, if this is this kind of change.

pub fn version_deleted(&self) -> Option<&CrateVersion>

Return the deleted version crate, if this is this kind of change.

pub fn versions(&self) -> &[CrateVersion]

Returns all versions affected by this change.

The returned slice usually has length 1. However, if a crate was purged from the index by an admin, all versions of the purged crate are returned.

Trait Implementations

impl Clone for Change

fn clone(&self) -> Change

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Change

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

Formats the value using the given formatter.

impl Display for Change

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

Formats the value using the given formatter.

impl PartialEq for Change

fn eq(&self, other: &Change) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Change

impl StructuralPartialEq for Change