Enum ItemKind 

pub enum ItemKind {
    Module,
    Struct,
    Enum,
    Union,
    Trait,
    Function,
    Method,
    Constant,
    Static,
    TypeAlias,
    Macro,
    Field,
    Variant,
    AssociatedType,
    AssociatedConstant,
}

What an item is, in the vocabulary rustdoc and the reference use. The kind decides what the policy may ask of an item, so it is recorded rather than inferred later.

Variants

Module

A module: mod, inline or in its own file.

Struct

A struct.

Enum

An enum.

Union

A union.

Trait

A trait.

Function

A free function, or an associated function with no receiver.

Method

A method: an associated function taking a receiver.

Constant

A const.

Static

A static.

TypeAlias

A type alias.

Macro

A macro_rules! carrying #[macro_export].

Field

A field of a public struct.

Variant

A variant of a public enum.

AssociatedType

An associated type of a trait: type Output;.

Kept apart from ItemKind::AssociatedConstant because rustdoc keeps them apart: one is anchored associatedtype. on its trait’s page and the other associatedconstant., so a single kind could not say where either is documented.

AssociatedConstant

An associated constant of a trait: const LIMIT: usize;, with a default or without.

Implementations

impl ItemKind

pub fn noun(self) -> &'static str

The word a finding uses for an item of this kind.

use majordomus_cli::quality::source::ItemKind;
assert_eq!(ItemKind::Method.noun(), "method");
assert_eq!(ItemKind::TypeAlias.noun(), "type alias");

pub fn carries_behaviour(self) -> bool

Does an item of this kind carry behaviour a reader could be shown running?

A module, a type, a function, a method and an exported macro do. A field, a variant, a constant, a static, a type alias and an associated item are values and names: an example of one is an example of whatever uses it, and demanding one buys the placeholder this subsystem exists to refuse.

use majordomus_cli::quality::source::ItemKind;
assert!(ItemKind::Function.carries_behaviour());
assert!(!ItemKind::Constant.carries_behaviour());

Trait Implementations

impl Clone for ItemKind

fn clone(&self) -> ItemKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ItemKind

impl Debug for ItemKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ItemKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ItemKind

impl JsonSchema for ItemKind

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 Ord for ItemKind

fn cmp(&self, other: &ItemKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ItemKind

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

fn partial_cmp(&self, other: &ItemKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ItemKind

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 ItemKind