Struct term_rustdoc::tree::CrateDoc

pub struct CrateDoc { /* private fields */ }

This should be the main data structure to refer to documentation and the items tree structure in public modules.

It’s cheap to clone and use a ID buffer to avoid the cost of generating a new string in query.

Implementations

impl CrateDoc

pub fn new(doc: Crate) -> CrateDoc

Methods from Deref<Target = IDMap>

pub fn dmodule(&self) -> &DModule

pub fn raw_crate_doc(&self) -> &Crate

pub fn use_id<T>(&self, id: &str, f: impl FnOnce(&Id) -> T) -> T

Use in a buffered way in hot querys.

pub fn indexmap(&self) -> &IndexMap

pub fn pathmap(&self) -> &PathMap

pub fn dmodule_show_prettier(&self) -> DocTree

FIXME: show_prettier should be renamed

pub fn dmodule_item_tree(&self) -> DocTree

This is the default tree view for most cases.

pub fn get_doc(&self, id: &str) -> Option<&str>

pub fn get_item(&self, id: &str) -> Option<&Item>

pub fn name<S>(&self, id: &S) -> XString

where S: ?Sized + IdAsStr,

• If the id refers to an Item with a name, use the name;
  • if name is None, try getting the name depending on item type (reexported local items may hit this);
• If id isn’t in IndexMap, try searching the PathMap for last path component (reexported external items may hit this);
• otherwise id.

pub fn get_path(&self, id: &str) -> Option<&ItemSummary>

pub fn path_with_kind_check<S, K>(&self, id: &S, kind: K) -> XString

where S: ?Sized + IdAsStr, K: Borrow<ItemKind>,

Like path, but with strict item kind checking. If the id doesn’t refer to an ItemSummary with exact given kind, emit a warn.

pub fn path(&self, id: &str) -> XString

Returns the full path if it exists, or name if it exists or id if neither exists.

pub fn path_or_name(&self, id: &str) -> Result<XString, XString>

Like path, but returns the choice for name/id fallback an Err variant.

Trait Implementations

impl Clone for CrateDoc

fn clone(&self) -> CrateDoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CrateDoc

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

Formats the value using the given formatter.

impl Default for CrateDoc

fn default() -> CrateDoc

Returns the “default value” for a type.

impl Deref for CrateDoc

type Target = IDMap

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for CrateDoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CrateDoc> for TreeLines

fn from(doc: CrateDoc) -> Self

Converts to this type from the input type.

impl Serialize for CrateDoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.