rustdoc_types

Enum Type

source
pub enum Type {
Show 14 variants ResolvedPath(Path), DynTrait(DynTrait), Generic(String), Primitive(String), FunctionPointer(Box<FunctionPointer>), Tuple(Vec<Type>), Slice(Box<Type>), Array { type_: Box<Type>, len: String, }, Pat { type_: Box<Type>, /* private fields */ }, ImplTrait(Vec<GenericBound>), Infer, RawPointer { is_mutable: bool, type_: Box<Type>, }, BorrowedRef { lifetime: Option<String>, is_mutable: bool, type_: Box<Type>, }, QualifiedPath { name: String, args: Box<GenericArgs>, self_type: Box<Type>, trait_: Option<Path>, },
}
Expand description

A type.

Variants§

§

ResolvedPath(Path)

Structs, enums, unions and type aliases, e.g. std::option::Option<u32>

§

DynTrait(DynTrait)

Dynamic trait object type (dyn Trait).

§

Generic(String)

Parameterized types. The contained string is the name of the parameter.

§

Primitive(String)

Built-in numeric types (e.g. u32, f32), bool, char.

§

FunctionPointer(Box<FunctionPointer>)

A function pointer type, e.g. fn(u32) -> u32, extern "C" fn() -> *const u8

§

Tuple(Vec<Type>)

A tuple type, e.g. (String, u32, Box<usize>)

§

Slice(Box<Type>)

An unsized slice type, e.g. [u32].

§

Array

An array type, e.g. [u32; 15]

Fields

§type_: Box<Type>

The type of the contained element.

§len: String

The stringified expression that is the length of the array.

Keep in mind that it’s not guaranteed to match the actual source code of the expression.

§

Pat

A pattern type, e.g. u32 is 1..

See the tracking issue

Fields

§type_: Box<Type>

The base type, e.g. the u32 in u32 is 1..

§

ImplTrait(Vec<GenericBound>)

An opaque type that satisfies a set of bounds, impl TraitA + TraitB + ...

§

Infer

A type that’s left to be inferred, _

§

RawPointer

A raw pointer type, e.g. *mut u32, *const u8, etc.

Fields

§is_mutable: bool

This is true for *mut _ and false for *const _.

§type_: Box<Type>

The type of the pointee.

§

BorrowedRef

&'a mut String, &str, etc.

Fields

§lifetime: Option<String>

The name of the lifetime of the reference, if provided.

§is_mutable: bool

This is true for &mut i32 and false for &i32

§type_: Box<Type>

The type of the pointee, e.g. the i32 in &'a mut i32

§

QualifiedPath

Associated types like <Type as Trait>::Name and T::Item where T: Iterator or inherent associated types like Struct::Name.

Fields

§name: String

The name of the associated type in the parent type.

<core::array::IntoIter<u32, 42> as Iterator>::Item
//                                            ^^^^
§args: Box<GenericArgs>

The generic arguments provided to the associated type.

<core::slice::IterMut<'static, u32> as BetterIterator>::Item<'static>
//                                                          ^^^^^^^^^
§self_type: Box<Type>

The type with which this type is associated.

<core::array::IntoIter<u32, 42> as Iterator>::Item
// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
§trait_: Option<Path>

None iff this is an inherent associated type.

Trait Implementations§

source§

impl Clone for Type

source§

fn clone(&self) -> Type

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 Type

source§

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

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

impl<'de> Deserialize<'de> for Type

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 Hash for Type

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 Type

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Type

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

source§

impl StructuralPartialEq for Type

Auto Trait Implementations§

§

impl Freeze for Type

§

impl RefUnwindSafe for Type

§

impl Send for Type

§

impl Sync for Type

§

impl Unpin for Type

§

impl UnwindSafe for Type

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, dst: *mut T)

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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,

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

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,