pub enum IndexSummary {
    Candidate(Summary),
    Yanked(Summary),
    Offline(Summary),
    Unsupported(Summary, u32),
}
Expand description

A parsed representation of a summary from the index. This is usually parsed from a line from a raw index file, or a JSON blob from on-disk index cache.

In addition to a full Summary, we have information on whether it is yanked.

Variants§

§

Candidate(Summary)

Available for consideration

§

Yanked(Summary)

Yanked within its registry

§

Offline(Summary)

Not available as we are offline and create is not downloaded yet

§

Unsupported(Summary, u32)

From a newer schema version and is likely incomplete or inaccurate

Implementations§

source§

impl IndexSummary

source

pub fn as_summary(&self) -> &Summary

Extract the summary from any variant

source

pub fn into_summary(self) -> Summary

Extract the summary from any variant

source

pub fn package_id(&self) -> PackageId

Extract the package id from any variant

source

pub fn is_yanked(&self) -> bool

Returns true if the index summary is Yanked.

source

pub fn is_offline(&self) -> bool

Returns true if the index summary is Offline.

source§

impl IndexSummary

source

fn parse( line: &[u8], source_id: SourceId, bindeps: bool ) -> CargoResult<IndexSummary>

Parses a line from the registry’s index file into an IndexSummary for a package.

The line provided is expected to be valid JSON. It is supposed to be a IndexPackage.

Trait Implementations§

source§

impl Clone for IndexSummary

source§

fn clone(&self) -> IndexSummary

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for IndexSummary

source§

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

Formats the value using the given formatter. Read more
source§

impl From<IndexSummary> for MaybeIndexSummary

source§

fn from(summary: IndexSummary) -> MaybeIndexSummary

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes

Size for each variant:

  • Candidate: 12 bytes
  • Yanked: 12 bytes
  • Offline: 12 bytes
  • Unsupported: 12 bytes