TraitDef in rustc_builtin_macros::deriving::generic - Rust
Description: API documentation for the Rust `TraitDef` struct in crate `rustc_builtin_macros`.

Skip to main content

## TraitDef

# Struct TraitDef

Source

    pub(crate) struct TraitDef<'a> {
        pub span: Span,
        pub path: Path,
        pub skip_path_as_bound: bool,
        pub needs_copy_as_bound_if_packed: bool,
        pub additional_bounds: Vec<Ty>,
        pub supports_unions: bool,
        pub methods: Vec<MethodDef<'a>>,
        pub associated_types: Vec<(Ident, Ty)>,
        pub is_const: bool,
        pub is_staged_api_crate: bool,
        pub safety: Safety,
        pub document: bool,
    }

## Fields§

§`span: Span`

The span for the current #[derive(Foo)] header.

§`path: Path`

Path of the trait, including any type parameters

§`skip_path_as_bound: bool`

Whether to skip adding the current trait as a bound to the type parameters of the type.

§`needs_copy_as_bound_if_packed: bool`

Whether `Copy` is needed as an additional bound on type parameters in a packed struct.

§`additional_bounds: Vec<Ty>`

Additional bounds required of any type parameters of the type, other than the current trait

§`supports_unions: bool`

Can this trait be derived for unions?

§`methods: Vec<MethodDef<'a>>`§`associated_types: Vec<(Ident, Ty)>`§`is_const: bool`§`is_staged_api_crate: bool`§`safety: Safety`

The safety of the `impl`.

§`document: bool`

Whether the added `impl` should appear in rustdoc output.

## Implementations§

Source§

### impl<'a> TraitDef<'a>

Source

#### pub(crate) fn expand( self, cx: &ExtCtxt<'_>, mitem: &MetaItem, item: &'a Annotatable, push: &mut dyn FnMut(Annotatable), )

Source

#### pub(crate) fn expand_ext( self, cx: &ExtCtxt<'_>, mitem: &MetaItem, item: &'a Annotatable, push: &mut dyn FnMut(Annotatable), from_scratch: bool, )

Source

#### fn create_derived_impl( &self, cx: &ExtCtxt<'_>, type_ident: Ident, generics: &Generics, field_tys: Vec<&Ty>, methods: Vec<Box<AssocItem>>, is_packed: bool, ) -> Box<Item>

Given that we are deriving a trait `DerivedTrait` for a type like:

ⓘ

    struct Struct<'a, ..., 'z, A, B: DeclaredTrait, C, ..., Z>
    where
        C: WhereTrait,
    {
        a: A,
        b: B::Item,
        b1: <B as DeclaredTrait>::Item,
        c1: <C as WhereTrait>::Item,
        c2: Option<<C as WhereTrait>::Item>,
        ...
    }

create an impl like:

ⓘ

    impl<'a, ..., 'z, A, B: DeclaredTrait, C, ..., Z>
    where
        C: WhereTrait,
        A: DerivedTrait + B1 + ... + BN,
        B: DerivedTrait + B1 + ... + BN,
        C: DerivedTrait + B1 + ... + BN,
        B::Item: DerivedTrait + B1 + ... + BN,
        <C as WhereTrait>::Item: DerivedTrait + B1 + ... + BN,
        ...
    {
        ...
    }

where B1, …, BN are the bounds given by `bounds_paths`.’. Z is a phantom type, and therefore does not get bound by the derived trait.

Source

#### fn expand_struct_def( &self, cx: &ExtCtxt<'_>, struct_def: &'a VariantData, type_ident: Ident, generics: &Generics, from_scratch: bool, is_packed: bool, ) -> Box<Item>

Source

#### fn expand_enum_def( &self, cx: &ExtCtxt<'_>, enum_def: &'a EnumDef, type_ident: Ident, generics: &Generics, from_scratch: bool, ) -> Box<Item>

Source§

### impl<'a> TraitDef<'a>

Source

#### fn summarise_struct( &self, cx: &ExtCtxt<'_>, struct_def: &'a VariantData, ) -> StaticFields<'a>

Source

#### fn create_struct_patterns( &self, cx: &ExtCtxt<'_>, struct_path: Path, struct_def: &'a VariantData, prefixes: &[String], by_ref: ByRef, ) -> ThinVec<Pat>

Source

#### fn create_fields<F>( &self, struct_def: &'a VariantData, mk_exprs: F, ) -> Vec<FieldInfo>
where F: Fn(usize, &FieldDef, Span) -> Vec<Box<Expr>>,

Source

#### fn mk_pattern_ident(&self, prefix: &str, i: usize) -> Ident

Source

#### fn create_struct_pattern_fields( &self, cx: &ExtCtxt<'_>, struct_def: &'a VariantData, prefixes: &[String], ) -> Vec<FieldInfo>

Source

#### fn create_struct_field_access_fields( &self, cx: &ExtCtxt<'_>, selflike_args: &[Box<Expr>], struct_def: &'a VariantData, is_packed: bool, ) -> Vec<FieldInfo>

## Auto Trait Implementations§

§

### impl<'a> !DynSend for TraitDef<'a>

§

### impl<'a> !DynSync for TraitDef<'a>

§

### impl<'a> !RefUnwindSafe for TraitDef<'a>

§

### impl<'a> !Send for TraitDef<'a>

§

### impl<'a> !Sync for TraitDef<'a>

§

### impl<'a> !UnwindSafe for TraitDef<'a>

§

### impl<'a> Freeze for TraitDef<'a>

§

### impl<'a> Unpin for TraitDef<'a>

§

### impl<'a> UnsafeUnpin for TraitDef<'a>

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
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, R> CollectAndApply<T, R> for T

Source§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

Source§

#### type Output = R

Source§

### impl<T> ErasedDestructor for T
where T: 'static,

Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

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

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

#### 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<K> IntoQueryKey<K> for K

Source§

#### fn into_query_key(self) -> K

Argument conversion from `Self` to `K`. This should always be a very cheap conversion, e.g. `LocalDefId::to_def_id`.
Source§

### impl<T> MaybeResult<T> for T

Source§

#### type Error = !

Source§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

Source§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
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<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

Source§

#### fn upcast(self, interner: I) -> U

Source§

### impl<I, T> UpcastFrom<I, T> for T

Source§

#### fn upcast_from(from: T, _tcx: I) -> T

Source§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

#### fn vzip(self) -> V

Source§

### impl<T> WithSubscriber for T

Source§

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

#### 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: 160 bytes