Struct move_bytecode_utils::layout::SerdeLayoutBuilder

pub struct SerdeLayoutBuilder<T> { /* private fields */ }

Type for building a registry of serde-reflection friendly struct layouts for Move types. The layouts created by this type are intended to be passed to the serde-generate tool to create struct bindings for Move types in source languages that use Move-based services. The LayoutBuilder can operate in two modes: “deep” and “shallow”. In shallow mode, it will generate a single layout for the struct or type passed in by the user (under the assumption that layouts for dependencies have been generated previously). In deep mode, it will generate layouts for all of the (transitive) dependencies of the type passed in, as well as layouts for the Move ground types like address and signer. The result is a self-contained registry with no unbound typenames

Implementations

impl<T: GetModule> SerdeLayoutBuilder<T>

pub fn new(module_resolver: T) -> Self

Create a LayoutBuilder with an empty registry and deep layout resolution

pub fn new_shallow(module_resolver: T) -> Self

Create a LayoutBuilder with an empty registry and shallow layout resolution

pub fn default_registry() -> Registry

Return a registry containing layouts for all the Move ground types (e.g., address)

pub fn registry(&self) -> &Registry

Get the registry of layouts generated so far

pub fn into_registry(self) -> Registry

Get the registry of layouts generated so far

pub fn build_type_layout(&mut self, t: TypeTag) -> Result<Format, T::Error>

Add layouts for all types used in t to the registry

pub fn build_struct_layout(&mut self, s: &StructTag) -> Result<Format, T::Error>

Add layouts for all types used in t to the registry