Struct scale_typegen::typegen::TypeGenerator
source · pub struct TypeGenerator<'a> { /* private fields */ }
Expand description
An interface for generating a types module.
Implementations§
source§impl<'a> TypeGenerator<'a>
impl<'a> TypeGenerator<'a>
sourcepub fn new(
type_registry: &'a PortableRegistry,
settings: &'a TypeGeneratorSettings
) -> Self
pub fn new( type_registry: &'a PortableRegistry, settings: &'a TypeGeneratorSettings ) -> Self
Construct a new TypeGenerator
.
sourcepub fn types_mod_ident(&self) -> &Ident
pub fn types_mod_ident(&self) -> &Ident
The name of the generated module which will contain the generated types.
sourcepub fn settings(&self) -> &TypeGeneratorSettings
pub fn settings(&self) -> &TypeGeneratorSettings
The settings used by this type generator.
sourcepub fn types(&self) -> &PortableRegistry
pub fn types(&self) -> &PortableRegistry
The type registry backing this type generator.
sourcepub fn generate_types_mod(&self) -> Result<ModuleIR, TypegenError>
pub fn generate_types_mod(&self) -> Result<ModuleIR, TypegenError>
Generate a module containing all types defined in the supplied type registry.
sourcepub fn create_type_ir(
&self,
ty: &Type<PortableForm>,
flat_derives_registry: &FlatDerivesRegistry
) -> Result<Option<TypeIR>, TypegenError>
pub fn create_type_ir( &self, ty: &Type<PortableForm>, flat_derives_registry: &FlatDerivesRegistry ) -> Result<Option<TypeIR>, TypegenError>
Creates an intermediate representation of a type that can later be converted into rust tokens.
sourcepub fn docs_from_scale_info(&self, docs: &[String]) -> TokenStream
pub fn docs_from_scale_info(&self, docs: &[String]) -> TokenStream
takes into account the settings value for should_gen_docs
sourcepub fn create_composite_ir_kind(
&self,
fields: &[Field<PortableForm>],
type_params: &mut TypeParameters
) -> Result<CompositeIRKind, TypegenError>
pub fn create_composite_ir_kind( &self, fields: &[Field<PortableForm>], type_params: &mut TypeParameters ) -> Result<CompositeIRKind, TypegenError>
Creates an intermediate representation of a composite.
sourcepub fn upcast_composite(&self, composite: &CompositeIR) -> TypeIR
pub fn upcast_composite(&self, composite: &CompositeIR) -> TypeIR
Creates the intermediate representation of a type from just a composite definition. This uses just the default derives and type params are left empty.
sourcepub fn resolve_field_type_path(
&self,
id: u32,
parent_type_params: &[TypeParameter],
original_name: Option<&str>
) -> Result<TypePath, TypegenError>
pub fn resolve_field_type_path( &self, id: u32, parent_type_params: &[TypeParameter], original_name: Option<&str> ) -> Result<TypePath, TypegenError>
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.
sourcepub fn resolve_type_path(&self, id: u32) -> Result<TypePath, TypegenError>
pub fn resolve_type_path(&self, id: u32) -> Result<TypePath, TypegenError>
Get the type path for the given type identifier.
sourcepub fn type_path_maybe_with_substitutes(
&self,
path: &Path<PortableForm>,
params: &[TypePath]
) -> TypePathType
pub fn type_path_maybe_with_substitutes( &self, path: &Path<PortableForm>, params: &[TypePath] ) -> TypePathType
Converts a scale_info::Path
into a TypePathType
, replacing all types that should be substituted.
sourcepub fn resolve_type(&self, id: u32) -> Result<&Type<PortableForm>, TypegenError>
pub fn resolve_type(&self, id: u32) -> Result<&Type<PortableForm>, TypegenError>
Resolves a type, given some type id.
Trait Implementations§
source§impl<'a> Clone for TypeGenerator<'a>
impl<'a> Clone for TypeGenerator<'a>
source§fn clone(&self) -> TypeGenerator<'a>
fn clone(&self) -> TypeGenerator<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'a> Debug for TypeGenerator<'a>
impl<'a> Debug for TypeGenerator<'a>
impl<'a> Copy for TypeGenerator<'a>
Auto Trait Implementations§
impl<'a> Freeze for TypeGenerator<'a>
impl<'a> RefUnwindSafe for TypeGenerator<'a>
impl<'a> !Send for TypeGenerator<'a>
impl<'a> !Sync for TypeGenerator<'a>
impl<'a> Unpin for TypeGenerator<'a>
impl<'a> UnwindSafe for TypeGenerator<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.