Struct term_rustdoc::tree::DModule

pub struct DModule {

    pub id: ID,
    pub modules: Vec<DModule>,
    pub structs: Vec<DStruct>,
    pub unions: Vec<DUnion>,
    pub enums: Vec<DEnum>,
    pub traits: Vec<DTrait>,
    pub functions: Vec<DFunction>,
    pub constants: Vec<DConstant>,
    pub statics: Vec<DStatic>,
    pub type_alias: Vec<DTypeAlias>,
    pub macros_decl: Vec<DMacroDecl>,
    pub macros_func: Vec<DMacroFunc>,
    pub macros_attr: Vec<DMacroAttr>,
    pub macros_derv: Vec<DMacroDerv>,
}

Module tree with structural items. All the items only carry ids without actual data.

Fields

id: ID

modules: Vec<DModule>

structs: Vec<DStruct>

unions: Vec<DUnion>

enums: Vec<DEnum>

traits: Vec<DTrait>

functions: Vec<DFunction>

constants: Vec<DConstant>

statics: Vec<DStatic>

type_alias: Vec<DTypeAlias>

macros_decl: Vec<DMacroDecl>

macros_func: Vec<DMacroFunc>

macros_attr: Vec<DMacroAttr>

macros_derv: Vec<DMacroDerv>

Implementations

impl DModule

pub fn new(map: &IDMap) -> Self

impl DModule

pub fn item_tree(&self, map: &IDMap) -> DocTree

The main tree view as public items in module tree.

pub fn item_tree_only_in_one_specified_mod(&self, map: &IDMap) -> DocTree

NOTE: this method doesn’t include nested modules; only returns one-level items with mod root.

impl DModule

pub fn current_items_counts(&self) -> ItemCount

Count the items under current module excluding the current module itself.

pub fn recursive_items_counts(&self) -> ItemCount

Count all the items excluding the root itself.

impl DModule

pub fn current_impls_counts(&self) -> ImplCounts

pub fn recursive_impls_counts(&self) -> ImplCounts

Trait Implementations

impl Debug for DModule

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

Formats the value using the given formatter.

impl Default for DModule

fn default() -> DModule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DModule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DModule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Show for DModule

To a recursive tree displayed with ids as nodes.

fn show(&self) -> DocTree

A plain form usually with basic info.

fn show_prettier(&self, map: &IDMap) -> DocTree

A fancier form with more item tags/icons before subnodes and other improvements.