Struct Item 

pub struct Item {

    pub path: String,
    pub name: String,
    pub kind: ItemKind,
    pub exported: bool,
    pub declared_pub: bool,
    pub file: String,
    pub line: usize,
    pub doc: String,
    pub examples: Vec<Example>,
    pub owner: String,
    pub trivial_accessor: bool,
    pub provided: bool,
    pub deprecated: Option<String>,
}

One item of the crate’s surface, as declared.

Fields

path: String

The full path a doc example would write: majordomus_cli::capability::model::Capability.

name: String

The last segment: Capability.

kind: ItemKind

What it is.

exported: bool

Reachable from outside the crate: declared pub, in a module chain that is pub all the way to the crate root, or re-exported by one. This is what missing_docs calls public and what a consumer can actually name.

declared_pub: bool

Declared pub on the item itself, whatever the modules above it are. A pub use of a type carries its pub members out of a private module and leaves the private ones behind, so the two facts have to be kept apart.

file: String

The file it is declared in, repository-relative to the crate directory.

line: usize

The line of the declaration, 1-based.

doc: String

The documentation attached to it, doc-comment markers stripped, fences included.

examples: Vec<Example>

The fenced blocks of that documentation, in order.

owner: String

The path of the item that owns this one: the module of a free item, the type of a method, the enum of a variant.

trivial_accessor: bool

A method or function whose body is one expression that only hands back what the receiver already holds. Recorded because an example of one shows nothing that the signature does not; see ItemKind::carries_behaviour.

provided: bool

A member of a trait that the trait supplies itself: a method with a default body, a constant with a default value. false for everything that is not a trait’s member.

Recorded because rustdoc anchors the two kinds of trait method differently — a required one as tymethod. and a provided one as method. — and the route of a method is therefore a fact about its declaration, not something a reader of the inventory could guess.

deprecated: Option<String>

The #[deprecated] note, when the item carries one.

Implementations

impl Item

pub fn prose_words(&self) -> usize

The words of the documentation, fenced blocks and the markers around them removed: the prose a reader is actually given.

use majordomus_cli::quality::source::Inventory;
let dir = tempfile::tempdir().unwrap();
let src = dir.path().join("src");
std::fs::create_dir_all(&src).unwrap();
std::fs::write(src.join("lib.rs"),
    "//! Root.\n/// Answers, and says with what.\n///\n/// ```\n/// let x = 1;\n/// ```\npub fn go() {}\n").unwrap();
let item = Inventory::of_crate(dir.path()).unwrap().item("majordomus_cli::go").unwrap().clone();
assert_eq!(item.prose_words(), 5, "the fenced block is not prose");

pub fn executable_examples(&self) -> Vec<&Example>

The examples of this item that the toolchain compiles.

use majordomus_cli::quality::source::Inventory;
let dir = tempfile::tempdir().unwrap();
let src = dir.path().join("src");
std::fs::create_dir_all(&src).unwrap();
std::fs::write(src.join("lib.rs"),
    "//! Root.\n/// Answers.\n///\n/// ```ignore\n/// go();\n/// ```\npub fn go() {}\n").unwrap();
let item = Inventory::of_crate(dir.path()).unwrap().item("majordomus_cli::go").unwrap().clone();
assert_eq!(item.examples.len(), 1);
assert!(item.executable_examples().is_empty(), "an ignored block is not evidence");

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Item

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Item

impl JsonSchema for Item

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 Item

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

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 Item