Skip to main content

BadgeInfo

Struct BadgeInfo 

Source
pub struct BadgeInfo {
    pub key: &'static str,
    pub official: bool,
    pub required: &'static [&'static str],
    pub optional: &'static [&'static str],
}
Expand description

A badge key cargo-readme understands, plus which attributes it reads.

This is the single source of truth behind cargo readme --list-badges. The keys here must stay in sync with the match arms in [super::manifest::process_badges]; a unit test in that module enforces it.

Fields§

§key: &'static str

The [badges] table key, e.g. "coveralls".

§official: bool

Whether crates.io documents this badge in the manifest reference.

§required: &'static [&'static str]

Attributes that must be present, or badge rendering fails.

§optional: &'static [&'static str]

Attributes that are read when present, otherwise defaulted.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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, U> Into<U> for T
where 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.