Enum rustdoc::clean::types::PrimitiveType

pub(crate) enum PrimitiveType {
    Isize,
    I8,
    I16,
    I32,
    I64,
    I128,
    Usize,
    U8,
    U16,
    U32,
    U64,
    U128,
    F32,
    F64,
    Char,
    Bool,
    Str,
    Slice,
    Array,
    Tuple,
    Unit,
    RawPointer,
    Reference,
    Fn,
    Never,
}

A primitive (aka, builtin) type.

This represents things like i32, str, etc.

N.B. This has to be different from hir::PrimTy because it also includes types that aren’t paths, like Self::Unit.

Variants

Isize

I8

I16

I32

I64

I128

Usize

U8

U16

U32

U64

U128

F32

F64

Char

Bool

Str

Slice

Array

Tuple

Unit

RawPointer

Reference

Fn

Never

Implementations

impl PrimitiveType

pub(crate) fn from_hir(prim: PrimTy) -> PrimitiveType

pub(crate) fn from_symbol(s: Symbol) -> Option<PrimitiveType>

pub(crate) fn simplified_types(
) -> &'static FxHashMap<PrimitiveType, ArrayVec<SimplifiedType, 3>>

pub(crate) fn impls<'tcx>(
    &self,
    tcx: TyCtxt<'tcx>
) -> impl Iterator<Item = DefId> + 'tcx

pub(crate) fn all_impls(tcx: TyCtxt<'_>) -> impl Iterator<Item = DefId> + '_

pub(crate) fn as_sym(&self) -> Symbol

pub(crate) fn primitive_locations(
    tcx: TyCtxt<'_>
) -> &FxHashMap<PrimitiveType, DefId>

Returns the DefId of the module with doc(primitive) for this primitive type. Panics if there is no such module.

This gives precedence to primitives defined in the current crate, and deprioritizes primitives defined in core, but otherwise, if multiple crates define the same primitive, there is no guarantee of which will be picked. In particular, if a crate depends on both std and another crate that also defines doc(primitive), then it’s entirely random whether std or the other crate is picked. (no_std crates are usually fine unless multiple dependencies define a primitive.)

Trait Implementations

impl Clone for PrimitiveType

fn clone(&self) -> PrimitiveType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrimitiveType

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

Formats the value using the given formatter.

impl From<FloatTy> for PrimitiveType

fn from(float_ty: FloatTy) -> PrimitiveType

Converts to this type from the input type.

impl From<FloatTy> for PrimitiveType

fn from(float_ty: FloatTy) -> PrimitiveType

Converts to this type from the input type.

impl From<IntTy> for PrimitiveType

fn from(int_ty: IntTy) -> PrimitiveType

Converts to this type from the input type.

impl From<IntTy> for PrimitiveType

fn from(int_ty: IntTy) -> PrimitiveType

Converts to this type from the input type.

impl From<PrimTy> for PrimitiveType

fn from(prim_ty: PrimTy) -> PrimitiveType

Converts to this type from the input type.

impl From<UintTy> for PrimitiveType

fn from(uint_ty: UintTy) -> PrimitiveType

Converts to this type from the input type.

impl From<UintTy> for PrimitiveType

fn from(uint_ty: UintTy) -> PrimitiveType

Converts to this type from the input type.

impl Hash for PrimitiveType

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<PrimitiveType> for PrimitiveType

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PrimitiveType

impl Eq for PrimitiveType

impl StructuralEq for PrimitiveType

impl StructuralPartialEq for PrimitiveType

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte

Size for each variant:

• Isize: 0 bytes
• I8: 0 bytes
• I16: 0 bytes
• I32: 0 bytes
• I64: 0 bytes
• I128: 0 bytes
• Usize: 0 bytes
• U8: 0 bytes
• U16: 0 bytes
• U32: 0 bytes
• U64: 0 bytes
• U128: 0 bytes
• F32: 0 bytes
• F64: 0 bytes
• Char: 0 bytes
• Bool: 0 bytes
• Str: 0 bytes
• Slice: 0 bytes
• Array: 0 bytes
• Tuple: 0 bytes
• Unit: 0 bytes
• RawPointer: 0 bytes
• Reference: 0 bytes
• Fn: 0 bytes
• Never: 0 bytes