Struct tame_index::krate::IndexKrate

pub struct IndexKrate {
    pub versions: Vec<IndexVersion>,
}

A whole crate with all its versions

Fields

versions: Vec<IndexVersion>

All versions of the crate, sorted chronologically by when it was published

Implementations

impl IndexKrate

pub fn write_cache_entry<W: Write>( &self, writer: &mut W, revision: &str, ) -> Result<(), Error>

Writes a cache entry with the specified revision to an std::io::Write

Note this method creates its own internal std::io::BufWriter, there is no need to wrap it yourself

impl IndexKrate

pub fn highest_version(&self) -> &IndexVersion

The highest version as per semantic versioning specification

Note this may be a pre-release or yanked, use Self::highest_normal_version to filter to the highest version that is not one of those

pub fn highest_normal_version(&self) -> Option<&IndexVersion>

Returns crate version with the highest version number according to semver, but excludes pre-release and yanked versions.

0.x.y versions are included.

May return None if the crate has only pre-release or yanked versions.

pub fn name(&self) -> &str

The crate’s unique registry name. Case-sensitive, mostly.

pub fn most_recent_version(&self) -> &IndexVersion

The last release by date, even if it’s yanked or less than highest version.

See Self::highest_normal_version

pub fn earliest_version(&self) -> &IndexVersion

First version ever published. May be yanked.

It is not guaranteed to be the lowest version number.

impl IndexKrate

pub fn new(index_path: impl AsRef<Path>) -> Result<Self, Error>

Parse an index file with all of crate’s versions.

The file must contain at least one version.

pub fn from_slice(bytes: &[u8]) -> Result<Self, Error>

Parse a crate from in-memory JSON-lines data

pub fn write_json_lines<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes this crate into a JSON-lines formatted buffer

Note this creates its own internal std::io::BufWriter, there is no need to wrap it in your own

Trait Implementations

impl Clone for IndexKrate

fn clone(&self) -> IndexKrate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexKrate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexKrate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IndexKrate

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for IndexKrate

impl StructuralPartialEq for IndexKrate