Skip to main content

TypeParam

Enum TypeParam 

Source
pub enum TypeParam {
    Type {
        name: String,
        span: Span,
        doc_comment: Option<DocComment>,
        default_type: Option<TypeAnnotation>,
        trait_bounds: Vec<TypePath>,
    },
    Const {
        name: String,
        span: Span,
        doc_comment: Option<DocComment>,
        ty: TypeAnnotation,
        default: Option<Expr>,
    },
}
Expand description

A generic parameter on a function, type, trait or impl header.

Two variants:

  • TypeParam::Type — the classic type-level parameter (<T>, <T: Bound>, <T = DefaultType>).
  • TypeParam::Const — a value-level const generic parameter (<const N: int>, <const N: int = 4>). Added in B.2 of the const-generics track; B.3 binds const args at monomorphization and B.4 substitutes them into specialized bodies. Until then most consumers treat const params as a placeholder — the AST captures the name, declared type, and optional default expression so later phases can wire them end-to-end.

Variants§

§

Type

A type parameter: T, T: Bound, T = DefaultType.

Fields

§name: String
§span: Span
§doc_comment: Option<DocComment>
§default_type: Option<TypeAnnotation>

Default type argument: T = int

§trait_bounds: Vec<TypePath>

Trait bounds: T: Comparable + Displayable

§

Const

A const generic parameter: const N: int, const N: int = 4.

Parsed in B.1/B.2. Monomorphization (B.3) and body substitution (B.4) are not yet implemented — most compiler passes currently treat this variant as a stub / placeholder.

Fields

§name: String
§span: Span
§doc_comment: Option<DocComment>
§ty: TypeAnnotation

Declared type: const N: int.

§default: Option<Expr>

Optional default value expression: = 4.

Implementations§

Source§

impl TypeParam

Source

pub fn name(&self) -> &str

The parameter’s declared name (T or N), common to both variants.

Source

pub fn span(&self) -> &Span

The parameter’s source span, common to both variants.

Source

pub fn doc_comment(&self) -> Option<&DocComment>

The parameter’s attached doc comment, common to both variants.

Source

pub fn trait_bounds(&self) -> &[TypePath]

Trait bounds, only present on the Type variant.

Returns an empty slice for const generics (they have no bounds).

Source

pub fn default_type(&self) -> Option<&TypeAnnotation>

Default type argument, only meaningful for the Type variant.

Source

pub fn is_const(&self) -> bool

True iff this is a const generic parameter.

Source

pub fn simple(name: impl Into<String>) -> Self

Convenience constructor for a plain type parameter with no bounds or default — the shape that stdlib bootstrap / method desugaring most often needs.

Trait Implementations§

Source§

impl Clone for TypeParam

Source§

fn clone(&self) -> TypeParam

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 TypeParam

Source§

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

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

impl<'de> Deserialize<'de> for TypeParam

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 PartialEq for TypeParam

Source§

fn eq(&self, other: &Self) -> 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 Serialize for TypeParam

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