Struct crates_index::Crate

pub struct Crate { /* fields omitted */ }

A single crate that contains many published versions

Implementations

impl Crate

pub fn new<P: AsRef<Path>>(index_path: P) -> Result<Crate>

Parse the file with crate versions.

The file must contain at least one version.

pub fn from_slice(bytes: &[u8]) -> Result<Crate>

Parse crate file from in-memory JSON data

pub fn from_cache_slice(bytes: &[u8], index_version: &str) -> Result<Crate>

Parse crate index entry from a .cache file, this can fail for a number of reasons

1. There is no entry for this crate
2. The entry was created with an older commit and might be outdated
3. The entry is a newer version than what can be read, would only happen if a future version of cargo changed the format of the cache entries
4. The cache entry is malformed somehow

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

Published versions of this crate sorted chronologically by date published

pub fn earliest_version(&self) -> &Version

Oldest version.

Warning: may not be the lowest version number.

pub fn latest_version(&self) -> &Version

Most recently published version. Warning: may not be the highest version.

pub fn highest_version(&self) -> SemverVersion

Returns the highest version as per semantic versioning specification.

pub fn highest_stable_version(&self) -> Option<SemverVersion>

Returns the highest version as per semantic versioning specification, filtering out versions with pre-release identifiers.

pub fn name(&self) -> &str

Trait Implementations

impl Clone for Crate

fn clone(&self) -> Crate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Crate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Crate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Crate

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

Serialize this value into the given Serde serializer.