Struct scale_info::build::FieldBuilder

pub struct FieldBuilder<N = NameNotAssigned, T = TypeNotAssigned> { /* private fields */ }

Construct a valid Field.

Implementations

impl FieldBuilder

pub fn new() -> Self

Create a new FieldBuilder.

impl<T> FieldBuilder<NameNotAssigned, T>

pub fn name(self, name: &'static str) -> FieldBuilder<NameAssigned, T>

Initialize the field name.

impl<N> FieldBuilder<N, TypeNotAssigned>

pub fn ty<TY>(self) -> FieldBuilder<N, TypeAssigned>where
    TY: TypeInfo + 'static + ?Sized,

Initialize the type of the field.

pub fn compact<TY>(self) -> FieldBuilder<N, TypeAssigned>where
    TY: HasCompact + TypeInfo + 'static,

Initializes the type of the field as a compact type.

impl<N, T> FieldBuilder<N, T>

pub fn type_name(self, type_name: &'static str) -> FieldBuilder<N, T>

Initialize the type name of a field (optional).

pub fn docs(self, _docs: &'static [&'static str]) -> FieldBuilder<N, T>

Doc capture is not enabled via the “docs” feature so this is a no-op.

pub fn docs_always(self, docs: &'static [&'static str]) -> Self

Initialize the documentation of a field, always captured even if the “docs” feature is not enabled.

impl<N> FieldBuilder<N, TypeAssigned>

pub fn finalize(self) -> Field<MetaForm>

Complete building and return a new Field.

Trait Implementations

impl<N, T> Default for FieldBuilder<N, T>

fn default() -> Self

Returns the “default value” for a type.