Struct term_rustdoc::tree::CrateDoc

source ·
pub struct CrateDoc { /* private fields */ }
Expand description

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§

Methods from Deref<Target = IDMap>§

source

pub fn dmodule(&self) -> &DModule

source

pub fn raw_crate_doc(&self) -> &Crate

source

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

Use in a buffered way in hot querys.

source

pub fn indexmap(&self) -> &IndexMap

source

pub fn pathmap(&self) -> &PathMap

source

pub fn dmodule_show_prettier(&self) -> DocTree

FIXME: show_prettier should be renamed

source

pub fn dmodule_item_tree(&self) -> DocTree

This is the default tree view for most cases.

source

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

source

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

source

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.
source

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

source

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.

source

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

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

source

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§

source§

impl Clone for CrateDoc

source§

fn clone(&self) -> CrateDoc

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CrateDoc

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for CrateDoc

source§

fn default() -> CrateDoc

Returns the “default value” for a type. Read more
source§

impl Deref for CrateDoc

§

type Target = IDMap

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<CrateDoc> for TreeLines

source§

fn from(doc: CrateDoc) -> Self

Converts to this type from the input type.
source§

impl Serialize for CrateDoc

source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,