Struct subxt_codegen::TypeGenerator

pub struct TypeGenerator<'a> { /* private fields */ }

Generate a Rust module containing all types defined in the supplied PortableRegistry.

Implementations

impl<'a> TypeGenerator<'a>

pub fn new( type_registry: &'a PortableRegistry, root_mod: &'static str, type_substitutes: TypeSubstitutes, derives: DerivesRegistry, crate_path: CratePath, should_gen_docs: bool ) -> Self

Construct a new TypeGenerator.

pub fn generate_types_mod(&self) -> Result<Module, CodegenError>

Generate a module containing all types defined in the supplied type registry.

pub fn resolve_type(&self, id: u32) -> Type<PortableForm>

Panics

If no type with the given id found in the type registry.

pub fn resolve_field_type_path( &self, id: u32, parent_type_params: &[TypeParameter], original_name: Option<&str> ) -> TypePath

Get the type path for a field of a struct or an enum variant, providing any generic type parameters from the containing type. This is for identifying where a generic type parameter is used in a field type e.g.

struct S<T> {
    a: T, // `T` is the "parent" type param from the containing type.
    b: Vec<Option<T>>, // nested use of generic type param `T`.
}

This allows generating the correct generic field type paths.

Panics

If no type with the given id found in the type registry.

pub fn resolve_type_path(&self, id: u32) -> TypePath

Get the type path for the given type identifier.

Panics

If no type with the given id found in the type registry.

pub fn default_derives(&self) -> &Derives

Returns the derives to be applied to all generated types.

pub fn types(&self) -> &PortableRegistry

Returns the type registry.

pub fn type_derives( &self, ty: &Type<PortableForm> ) -> Result<Derives, CodegenError>

Returns the derives to be applied to a generated type.

Trait Implementations

impl<'a> Debug for TypeGenerator<'a>

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

Formats the value using the given formatter.