Struct TypePath

pub struct TypePath(/* private fields */);

An opaque struct representing a type path. The main usage of this is to spit out as tokens in some quote!{ ... } macro; the inner structure should be unimportant.

Implementations

impl TypePath

pub fn from_parameter(param: TypeParameter) -> TypePath

Construct a TypePath from a TypeParameter

pub fn from_type(ty: TypePathType) -> TypePath

Construct a TypePath from a TypeParameter

pub fn from_syn_path(path: Path) -> TypePath

Construct a TypePath from a syn::TypePath

pub fn is_compact(&self) -> bool

Returns true, if this is a concrete compact type.

pub fn is_string(&self) -> bool

Returns true, if this is a concrete string type.

pub fn is_uint_up_to_u128(&self) -> bool

Returns true, if this is an unsigned integer (anywhere between u8 and u128).

pub fn parent_type_params(&self) -> BTreeSet<TypeParameter>

Returns the type parameters in a path which are inherited from the containing type.

Example

struct S<T> {
    a: Vec<Option<T>>, // the parent type param here is `T`
}

pub fn vec_type_param(&self) -> Option<&TypePath>

Gets the vector type parameter if the data is represented as TypeDef::Sequence.

Note: Utilized for transforming std::vec::Vec<T> into slices &[T] for the storage API.

Trait Implementations

impl Clone for TypePath

fn clone(&self) -> TypePath

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TypePath

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

Formats the value using the given formatter.

impl ToTokensWithSettings for TypePath

fn to_tokens(&self, tokens: &mut TokenStream, settings: &TypeGeneratorSettings)

Translate a type into rust tokens.

fn to_token_stream(&self, settings: &TypeGeneratorSettings) -> TokenStream

Translate a type into rust tokens.