pub struct Box<T> where
    T: SpreadLayout
{ /* private fields */ }
Expand description

A dynamically allocated storage entity.

Users can use this in order to make certain SpreadLayout storage entities used in contexts that require a PackedLayout storage entity by simply packing the storage entity within a storage::Box.

Dynamic allocations caused by the creation of storage::Box instances do have some limited overhead:

  • The dynamic allocation itself has to be provided by some dynamic storage allocator that needs to be invoked.
  • Each dynamic storage allocation implies roughly 1.12 bits of overhead.
  • Upon ever first dereferencing of a storage::Box instance a cryptographic hash routine is run in order to compute the underlying storage key.

Use this abstraction with caution due to the aforementioned performance implications.

Implementations

Creates a new boxed entity.

Returns a shared reference to the boxed value.

Note

This loads the value from the pointed to contract storage if this did not happen before.

Panics

If loading from contract storage failed.

Returns an exclusive reference to the boxed value.

Note

This loads the value from the pointed to contract storage if this did not happen before.

Panics

If loading from contract storage failed.

Trait Implementations

Performs the conversion.

Performs the conversion.

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Formats the value using the given formatter. Read more

Attempt to deserialise the value from input.

Attempt to skip the encoded value from input. Read more

Returns the fixed encoded size of the type. Read more

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

Formats the value using the given formatter. Read more

Executes the destructor for this type. Read more

If possible give a hint of expected size of the encoding. Read more

Convert self to a slice and append it to the destination.

Convert self to an owned vector.

Convert self to a slice and then invoke the given closure with it.

Calculates the encoded size. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

Indicates to self that is has just been pulled from the storage. Read more

Indicates to self that it is about to be pushed to contract storage. Read more

Indicates to self that it is about to be cleared from contract storage. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

This method returns an ordering between self and other values if one exists. Read more

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

The footprint of the type. Read more

Pulls an instance of Self from the contract storage. Read more

Pushes an instance of Self to the contract storage. Read more

Clears an instance of Self from the contract storage. Read more

Indicates whether a type requires deep clean-up of its state meaning that a clean-up routine has to decode an entity into an instance in order to eventually recurse upon its tear-down. This is not required for the majority of primitive data types such as i32, however types such as storage::Box that might want to forward the clean-up procedure to their inner T require a deep clean-up. Read more

Returns the static storage layout of Self. Read more

The type identifying for which type info is provided. Read more

Returns the static type identifier for Self.

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

Decode Self and consume all of the given input data. Read more

Decode Self and consume all of the given input data. Read more

Decode Self and advance input by the number of bytes consumed. Read more

Decode Self with the given maximum recursion depth. Read more

Performs the conversion.

Performs the conversion.

Return an encoding of Self prepended by given slice.

Should always be Self

Converts the given value to a String. Read more

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.