Struct PublicApiQuality 

pub struct PublicApiQuality {
    pub items: usize,
    pub documented: usize,
    pub owe_example: usize,
    pub exampled: usize,
    pub exempt: Vec<Exemption>,
}

What the exported item surface looks like.

Fields

items: usize

Items the crate exports, of every kind.

documented: usize

Of those, how many carry documentation.

owe_example: usize

How many owe an executable example under the policy.

exampled: usize

Of those, how many have one that counts.

exempt: Vec<Exemption>

How many are exempt from the example policy for a structural reason, and why, by reason, so that the exemptions are visible rather than implied by a subtraction.

Trait Implementations

impl Clone for PublicApiQuality

fn clone(&self) -> PublicApiQuality

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublicApiQuality

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

Formats the value using the given formatter.

impl Default for PublicApiQuality

fn default() -> PublicApiQuality

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PublicApiQuality

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PublicApiQuality

impl JsonSchema for PublicApiQuality

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for PublicApiQuality

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PublicApiQuality