Enum ink_metadata::layout::Layout

pub enum Layout<F: Form = MetaForm> {
    Leaf(LeafLayout<F>),
    Root(RootLayout<F>),
    Hash(HashLayout<F>),
    Array(ArrayLayout<F>),
    Struct(StructLayout<F>),
    Enum(EnumLayout<F>),
}

Represents the static storage layout of an ink! smart contract.

Variants

Leaf(LeafLayout<F>)

An encoded cell.

This is the only leaf node within the layout graph. All layout nodes have this node type as their leafs.

Root(RootLayout<F>)

The root cell defines the storage key for all sub-trees.

Hash(HashLayout<F>)

A layout that hashes values into the entire storage key space.

This is commonly used by ink! hashmaps and similar data structures.

Array(ArrayLayout<F>)

An array of type associated with storage cell.

Struct(StructLayout<F>)

A struct layout with fields of different types.

Enum(EnumLayout<F>)

An enum layout with a discriminant telling which variant is layed out.

Trait Implementations

impl<F: Debug + Form> Debug for Layout<F>

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

Formats the value using the given formatter.

impl<'de, F: Form> Deserialize<'de> for Layout<F>

where F::Type: DeserializeOwned, F::String: DeserializeOwned,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Form> From<ArrayLayout<F>> for Layout<F>

fn from(value: ArrayLayout<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<EnumLayout<F>> for Layout<F>

fn from(value: EnumLayout<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<HashLayout<F>> for Layout<F>

fn from(value: HashLayout<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<LeafLayout<F>> for Layout<F>

fn from(value: LeafLayout<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<RootLayout<F>> for Layout<F>

fn from(value: RootLayout<F>) -> Self

Converts to this type from the input type.

impl<F: Form> From<StructLayout<F>> for Layout<F>

fn from(value: StructLayout<F>) -> Self

Converts to this type from the input type.

impl IntoPortable for Layout

type Output = Layout<PortableForm>

The portable version of Self.

fn into_portable(self, registry: &mut Registry) -> Self::Output

Convert self to the portable form by using the registry for caching.

impl<F: Form + JsonSchema> JsonSchema for Layout<F>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<F: Ord + Form> Ord for Layout<F>

fn cmp(&self, other: &Layout<F>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<F: PartialEq + Form> PartialEq for Layout<F>

fn eq(&self, other: &Layout<F>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: PartialOrd + Form> PartialOrd for Layout<F>

fn partial_cmp(&self, other: &Layout<F>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl<F: Form> Serialize for Layout<F>

where F::Type: Serialize, F::String: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: Eq + Form> Eq for Layout<F>

impl<F: Form> StructuralPartialEq for Layout<F>