Enum rustdoc::clean::types::SubstParam

source · 
pub(crate) enum SubstParam {
    Type(Type),
    Lifetime(Lifetime),
    Constant(Constant),
}
Expand description

The type, lifetime, or constant that a private type alias’s parameter should be replaced with when expanding a use of that type alias.

For example:

type PrivAlias<T> = Vec<T>;

pub fn public_fn() -> PrivAlias<i32> { vec![] }
Run

public_fn’s docs will show it as returning Vec<i32>, since PrivAlias is private. SubstParam is used to record that T should be mapped to i32.

Variants

Type(Type)

Lifetime(Lifetime)

Constant(Constant)

Implementations

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
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: 88 bytes

Size for each variant:

  • Type: 56 bytes
  • Lifetime: 4 bytes
  • Constant: 88 bytes