PrimitiveType in rustdoc::clean::types - Rust
Description: A primitive (aka, builtin) type.

Skip to main content

## PrimitiveType

# Enum PrimitiveType

Source

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

Expand description

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

§

### F16

§

### F32

§

### F64

§

### F128

§

### Char

§

### Bool

§

### Str

§

### Slice

§

### Array

§

### Pat

§

### FieldOf

§

### Tuple

§

### Unit

§

### RawPointer

§

### Reference

§

### Fn

§

### Never

## Implementations§

Source§

### impl PrimitiveType

Source

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

Source

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

Source

#### pub(crate) fn from_ty(ty: Ty<'_>) -> Option<Self>

Source

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

Source

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

Source

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

Source

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

Source

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

Returns the DefId of the module with `rustc_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 `rustc_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§

Source§

### impl Clone for PrimitiveType

Source§

#### fn clone(&self) -> PrimitiveType

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 Debug for PrimitiveType

Source§

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

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

### impl From<FloatTy> for PrimitiveType

Source§

#### fn from(float_ty: FloatTy) -> PrimitiveType

Converts to this type from the input type.
Source§

### impl From<IntTy> for PrimitiveType

Source§

#### fn from(int_ty: IntTy) -> PrimitiveType

Converts to this type from the input type.
Source§

### impl From<PrimTy> for PrimitiveType

Source§

#### fn from(prim_ty: PrimTy) -> PrimitiveType

Converts to this type from the input type.
Source§

### impl From<UintTy> for PrimitiveType

Source§

#### fn from(uint_ty: UintTy) -> PrimitiveType

Converts to this type from the input type.
Source§

### impl Hash for PrimitiveType

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 PrimitiveType

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 (const: unstable) · 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 Copy for PrimitiveType

Source§

### impl Eq for PrimitiveType

Source§

### impl StructuralPartialEq for PrimitiveType

## Auto Trait Implementations§

§

### impl Freeze for PrimitiveType

§

### impl RefUnwindSafe for PrimitiveType

§

### impl Send for PrimitiveType

§

### impl Sync for PrimitiveType

§

### impl Unpin for PrimitiveType

§

### impl UnsafeUnpin for PrimitiveType

§

### impl UnwindSafe for PrimitiveType

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

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

§

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

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

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

§

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

§

### impl<T> Instrument for T

§

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

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

#### 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> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
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.
§

### impl<T> WithSubscriber for T

§

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

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more

## 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
- `F16`: 0 bytes
- `F32`: 0 bytes
- `F64`: 0 bytes
- `F128`: 0 bytes
- `Char`: 0 bytes
- `Bool`: 0 bytes
- `Str`: 0 bytes
- `Slice`: 0 bytes
- `Array`: 0 bytes
- `Pat`: 0 bytes
- `FieldOf`: 0 bytes
- `Tuple`: 0 bytes
- `Unit`: 0 bytes
- `RawPointer`: 0 bytes
- `Reference`: 0 bytes
- `Fn`: 0 bytes
- `Never`: 0 bytes