scale_info::build

Struct TypeBuilder

Source
pub struct TypeBuilder<F: Form = MetaForm, S = PathNotAssigned> { /* private fields */ }
Expand description

Builds a Type

Implementations§

Source§

impl<F: Form> TypeBuilder<F, PathNotAssigned>

Source

pub fn path(self, path: Path<F>) -> TypeBuilder<F, PathAssigned>

Set the Path for the type

Source§

impl<F: Form> TypeBuilder<F, PathAssigned>

Source

pub fn variant(self, builder: Variants<F>) -> Type<F>

Construct a “variant” type i.e an enum

Source

pub fn composite<T>(self, fields: FieldsBuilder<F, T>) -> Type<F>

Construct a “composite” type i.e. a struct

Source§

impl<F: Form, S> TypeBuilder<F, S>

Source

pub fn type_params<I>(self, type_params: I) -> Self
where I: IntoIterator<Item = TypeParameter<F>>,

Set the type parameters if it’s a generic type

Source§

impl<S> TypeBuilder<MetaForm, S>

Source

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

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

Source

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

Set the type documentation, always captured even if the “docs” feature is not enabled.

Trait Implementations§

Source§

impl<F: Form, S> Default for TypeBuilder<F, S>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<F, S> Freeze for TypeBuilder<F, S>

§

impl<F, S> RefUnwindSafe for TypeBuilder<F, S>
where <F as Form>::String: RefUnwindSafe, <F as Form>::Type: RefUnwindSafe,

§

impl<F, S> Send for TypeBuilder<F, S>
where <F as Form>::String: Send, <F as Form>::Type: Send,

§

impl<F, S> Sync for TypeBuilder<F, S>
where <F as Form>::String: Sync, <F as Form>::Type: Sync,

§

impl<F, S> Unpin for TypeBuilder<F, S>
where <F as Form>::String: Unpin, <F as Form>::Type: Unpin,

§

impl<F, S> UnwindSafe for TypeBuilder<F, S>
where <F as Form>::String: UnwindSafe, <F as Form>::Type: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> JsonSchemaMaybe for T