Skip to main content

ItemKind

Enum ItemKind 

Source
pub enum ItemKind {
Show 14 variants Module, Struct, Trait, Enum, Union, Fn, Type, Constant, Static, Macro, Attribute, Derive, Variant, StructField,
}
Expand description

Canonical rustdoc item kinds used by docs.rs HTML.

Variants§

§

Module

Module page.

§

Struct

Struct page.

§

Trait

Trait page.

§

Enum

Enum page.

§

Union

Union page.

§

Fn

Function or method page.

§

Type

Type alias page.

§

Constant

Constant page.

§

Static

Static page.

§

Macro

Macro page.

§

Attribute

Attribute macro page.

§

Derive

Derive macro page.

§

Variant

Enum variant — always a member of its enum, never its own page.

§

StructField

Struct or union field — always a member of its type, never its own page.

Implementations§

Source§

impl ItemKind

Source

pub fn as_str(self) -> &'static str

Stable JSON / filter string.

Source

pub fn owns_page(self) -> bool

Whether rustdoc emits a standalone {prefix}.{name}.html page for this kind.

Self::Variant and Self::StructField return false: rustdoc renders them only as anchors inside the parent’s page. Asking for one without a parent-qualified path must fail with that explanation, because the alternative — falling through to the free-item branch — would build variant.Some.html, a URL no rustdoc has ever served.

Source

pub fn file_prefix(self) -> Option<&'static str>

Filename prefix in rustdoc HTML (e.g. struct, fn, attr, constant).

None for kinds that own no page (Self::owns_page); callers building a free-item URL must reject those before reaching here.

Modern rustdoc/docs.rs uses constant.NAME.html (not legacy const.NAME.html).

Source

pub fn parse(input: &str) -> AppResult<Self>

Parse CLI / filter aliases into canonical kind.

§Errors

Returns crate::error::ErrorKind::InvalidInput when input is not a known kind alias.

Source

pub fn parse_with_echo(input: &str) -> AppResult<(Self, &'static str)>

Parse kind for URL building plus the wire echo string for item_type.

method maps to ItemKind::Fn for rustdoc URLs but echoes as "method".

§Errors

Returns crate::error::ErrorKind::InvalidInput when input is not a known kind alias.

Source

pub fn from_href(href: &str) -> Option<Self>

Infer kind from all.html href (e.g. struct.Name.html, attr.foo.html).

Accepts modern constant. and legacy const. prefixes for Constant.

Trait Implementations§

Source§

impl Clone for ItemKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ItemKind

Source§

impl Debug for ItemKind

Source§

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

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

impl<'de> Deserialize<'de> for ItemKind

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 Eq for ItemKind

Source§

impl Hash for ItemKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ItemKind

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ItemKind

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
Source§

impl StructuralPartialEq for ItemKind

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

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

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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