Struct rune::module::VariantMut

pub struct VariantMut<'a, T>
where
    T: ?Sized + TypeOf,
{ /* private fields */ }

Handle to a a variant inserted into a module which allows for mutation of its metadata.

Implementations

impl<T> VariantMut<'_, T>

where T: ?Sized + TypeOf,

pub fn docs<I>(self, docs: I) -> Result<Self, ContextError>

where I: IntoIterator, I::Item: AsRef<str>,

Set documentation for an inserted type.

This completely replaces any existing documentation.

pub fn static_docs( self, docs: &'static [&'static str] ) -> Result<Self, ContextError>

Set static documentation.

This completely replaces any existing documentation.

pub fn make_named( self, fields: &'static [&'static str] ) -> Result<Self, ContextError>

Mark the given variant with named fields.

pub fn make_unnamed(self, fields: usize) -> Result<Self, ContextError>

Mark the given variant with unnamed fields.

pub fn make_empty(self) -> Result<Self, ContextError>

Mark the given variant as empty.

pub fn constructor<F, A>(self, constructor: F) -> Result<Self, ContextError>

where F: Function<A, Plain, Return = T>,

Register a constructor method for the current variant.