## Tree

# Enum Tree

Source

    pub(crate) enum Tree<D, R, T>where
        D: Def,
        R: Region,
        T: Type,{
        Seq(Vec<Self>),
        Alt(Vec<Self>),
        Def(D),
        Ref(Reference<R, T>),
        Byte(Byte),
    }

Expand description

A tree-based representation of a type layout.

Invariants:

1. All paths through the layout have the same length (in bytes).

Nice-to-haves:

1. An `Alt` is never directly nested beneath another `Alt`.
2. A `Seq` is never directly nested beneath another `Seq`.
3. `Seq`s and `Alt`s with a single member do not exist.

## Variants§

§

### Seq(Vec<Self>)

A sequence of successive layouts.

§

### Alt(Vec<Self>)

A choice between alternative layouts.

§

### Def(D)

A definition node.

§

### Ref(Reference<R, T>)

A reference node.

§

### Byte(Byte)

A byte node.

## Implementations§

Source§

### impl<'tcx> Tree<Def<'tcx>, Region<'tcx>, Ty<'tcx>>

Source

#### pub(crate) fn from_ty(ty: Ty<'tcx>, cx: LayoutCx<'tcx>) -> Result<Self, Err>

Source

#### fn from_tuple( (ty, layout): (Ty<'tcx>, Layout<'tcx>), members: &'tcx List<Ty<'tcx>>, cx: LayoutCx<'tcx>, ) -> Result<Self, Err>

Constructs a `Tree` from a tuple.

Source

#### fn from_struct( (ty, layout): (Ty<'tcx>, Layout<'tcx>), def: AdtDef<'tcx>, cx: LayoutCx<'tcx>, ) -> Result<Self, Err>

Constructs a `Tree` from a struct.

##### §Panics

Panics if `def` is not a struct definition.

Source

#### fn from_enum( (ty, layout): (Ty<'tcx>, Layout<'tcx>), def: AdtDef<'tcx>, cx: LayoutCx<'tcx>, ) -> Result<Self, Err>

Constructs a `Tree` from an enum.

##### §Panics

Panics if `def` is not an enum definition.

Source

#### fn from_variant( def: Def<'tcx>, tag: Option<(ScalarInt, VariantIdx, TagEncoding<VariantIdx>)>, (ty, layout): (Ty<'tcx>, Layout<'tcx>), total_size: Size, cx: LayoutCx<'tcx>, ) -> Result<Self, Err>

Constructs a `Tree` from a ‘variant-like’ layout.

A ‘variant-like’ layout includes those of structs and, of course, enum variants. Pragmatically speaking, this method supports anything with `FieldsShape::Arbitrary`.

Note: This routine assumes that the optional `tag` is the first field, and enum callers should check that `tag_field` is, in fact, `0`.

Source

#### fn from_tag(tag: ScalarInt, tcx: TyCtxt<'tcx>) -> Self

Constructs a `Tree` representing the value of a enum tag.

Source

#### fn from_union( (ty, layout): (Ty<'tcx>, Layout<'tcx>), def: AdtDef<'tcx>, cx: LayoutCx<'tcx>, ) -> Result<Self, Err>

Constructs a `Tree` from a union.

##### §Panics

Panics if `def` is not a union definition.

Source§

### impl<D, R, T> Tree<D, R, T>
where D: Def, R: Region, T: Type,

Source

#### pub(crate) fn def(def: D) -> Self

A `Tree` consisting only of a definition node.

Source

#### pub(crate) fn uninhabited() -> Self

A `Tree` representing an uninhabited type.

Source

#### pub(crate) fn unit() -> Self

A `Tree` representing a zero-sized type.

Source

#### pub(crate) fn uninit() -> Self

A `Tree` containing a single, uninitialized byte.

Source

#### pub(crate) fn bool() -> Self

A `Tree` representing the layout of `bool`.

Source

#### pub(crate) fn u8() -> Self

A `Tree` whose layout matches that of a `u8`.

Source

#### pub(crate) fn char(order: Endian) -> Self

A `Tree` whose layout matches that of a `char`.

Source

#### pub(crate) fn nonzero(width_in_bytes: u64) -> Self

A `Tree` whose layout matches `std::num::NonZeroXxx`.

Source

#### pub(crate) fn bytes<const N: usize, B: Into<Byte>>(bytes: [B; N]) -> Self

Source

#### pub(crate) fn byte(byte: impl Into<Byte>) -> Self

Source

#### pub(crate) fn number(width_in_bytes: u64) -> Self

A `Tree` whose layout is a number of the given width.

Source

#### pub(crate) fn padding(width_in_bytes: usize) -> Self

A `Tree` whose layout is entirely padding of the given width.

Source

#### pub(crate) fn prune<F>(self, f: &F) -> Tree<!, R, T>
where F: Fn(D) -> bool,

Remove all `Def` nodes, and all branches of the layout for which `f` produces `true`.

Source

#### pub(crate) fn is_inhabited(&self) -> bool

Produces `true` if `Tree` is an inhabited type; otherwise false.

Source

#### pub(crate) fn from_big_endian<const N: usize, B: Into<Byte>>( order: Endian, bytes: [B; N], ) -> Self

Produces a `Tree` which represents a sequence of bytes stored in `order`.

`bytes` is taken to be in big-endian byte order, and its order will be swapped if `order == Endian::Little`.

Source

#### pub(crate) fn seq<const N: usize>(trees: [Tree<D, R, T>; N]) -> Self

Produces a `Tree` where each of the trees in `trees` are sequenced one after another.

Source

#### pub(crate) fn alt<const N: usize>(trees: [Tree<D, R, T>; N]) -> Self

Produces a `Tree` where each of the trees in `trees` are accepted as alternative layouts.

Source

#### pub(crate) fn then(self, other: Self) -> Self

Produces a new `Tree` where `other` is sequenced after `self`.

Source

#### pub(crate) fn or(self, other: Self) -> Self

Produces a new `Tree` accepting either `self` or `other` as alternative layouts.

## Trait Implementations§

Source§

### impl<D, R, T> Clone for Tree<D, R, T>
where D: Def + Clone, R: Region + Clone, T: Type + Clone,

Source§

#### fn clone(&self) -> Tree<D, R, T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

#### fn clone_from(&mut self, source: &Self)

Performs copy-assignment from `source`. Read more
Source§

### impl<D, R, T> Debug for Tree<D, R, T>
where D: Def + Debug, R: Region + Debug, T: Type + Debug,

Source§

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

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

### impl<D, R, T> Hash for Tree<D, R, T>
where D: Def + Hash, R: Region + Hash, T: Type + Hash,

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<D, R, T> PartialEq for Tree<D, R, T>
where D: Def + PartialEq, R: Region + PartialEq, T: Type + PartialEq,

Source§

#### fn eq(&self, other: &Tree<D, R, T>) -> bool

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · 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<D, R, T> Eq for Tree<D, R, T>
where D: Def + Eq, R: Region + Eq, T: Type + Eq,

Source§

### impl<D, R, T> StructuralPartialEq for Tree<D, R, T>
where D: Def, R: Region, T: Type,

## Auto Trait Implementations§

§

### impl<D, R, T> DynSend for Tree<D, R, T>
where D: DynSend, R: DynSend, T: DynSend,

§

### impl<D, R, T> DynSync for Tree<D, R, T>
where D: DynSync, R: DynSync, T: DynSync,

§

### impl<D, R, T> Freeze for Tree<D, R, T>
where D: Freeze, R: Freeze, T: Freeze,

§

### impl<D, R, T> RefUnwindSafe for Tree<D, R, T>
where D: RefUnwindSafe, R: RefUnwindSafe, T: RefUnwindSafe,

§

### impl<D, R, T> Send for Tree<D, R, T>
where D: Send, R: Send, T: Send,

§

### impl<D, R, T> Sync for Tree<D, R, T>
where D: Sync, R: Sync, T: Sync,

§

### impl<D, R, T> Unpin for Tree<D, R, T>
where D: Unpin, R: Unpin, T: Unpin,

§

### impl<D, R, T> UnwindSafe for Tree<D, R, T>
where D: UnwindSafe, R: UnwindSafe, T: UnwindSafe,

## 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> AnyEq for T
where T: Any + PartialEq,

Source§

#### fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

#### fn as_any(&self) -> &(dyn Any + 'static)

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, 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> DynClone for T
where T: Clone,

Source§

#### fn __clone_box(&self, _: Private) -> *mut ()

Source§

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

Source§

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

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

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

Source§

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

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

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

Source§

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

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<P> IntoQueryParam<P> for P

Source§

#### fn into_query_param(self) -> P

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> 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<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<Tcx, T> Value<Tcx> for T
where Tcx: DepContext,

Source§

#### default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed, ) -> T

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

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

## Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.