Struct ModuleView 

pub struct ModuleView {
    pub id: String,
    pub title: String,
    pub description: String,
    pub stability: Option<Stability>,
    pub source: String,
    pub capabilities: usize,
    pub capability_ids: Vec<String>,
    pub source_path: Option<String>,
    pub rustdoc: Option<ReferencePage>,
}

One module.

Fields

id: String

The module id.

title: String

The short name.

description: String

One paragraph.

stability: Option<Stability>

Where the module stands, when it declared it.

source: String

builtin or declarative.

capabilities: usize

Capabilities it composes.

capability_ids: Vec<String>

The ids of its builtin capabilities, in registry order; empty for a declarative module.

source_path: Option<String>

Repository-relative path of the Rust file the module’s descriptors were composed in, for a builtin module.

rustdoc: Option<ReferencePage>

The page the crate’s published reference documents the module on, for a builtin module whose Rust module the crate exports. Absent for a module rustdoc gives no page (pub(crate) or private), for a declarative module, and for every module of a repository without the crate.

Trait Implementations

impl Clone for ModuleView

fn clone(&self) -> ModuleView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleView

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

Formats the value using the given formatter.

impl Ordered for ModuleView

A module is presented by its id, the same string its capabilities are prefixed with.

fn order_key(&self) -> OrderKey<'_>

The four parts this item is ordered by. Borrowed from the item: building a key allocates nothing, so sorting a large collection costs the comparisons and no more.

impl Serialize for ModuleView

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

where __S: Serializer,

Serialize this value into the given Serde serializer.