Enum rustdoc::clean::types::SubstParam

pub(crate) enum SubstParam {
    Type(Type),
    Lifetime(Lifetime),
    Constant(Constant),
}

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![] }

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

impl SubstParam

pub(crate) fn as_ty(&self) -> Option<&Type>

pub(crate) fn as_lt(&self) -> Option<&Lifetime>

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: 64 bytes

Size for each variant:

• Type: 40 bytes
• Lifetime: 8 bytes
• Constant: 64 bytes