Struct FunctionBuilder

pub struct FunctionBuilder<Params, Returns>
where
    Params: TypedMultiValue,
    Returns: TypedMultiValue,
{
    pub doc: Option<Cow<'static, str>>,
    pub params: Vec<Param>,
    pub returns: Vec<Return>,
    /* private fields */
}

Builder to add documentation to parameters and return types along with the overall function type

Fields

doc: Option<Cow<'static, str>>

params: Vec<Param>

returns: Vec<Return>

Implementations

impl<Params, Returns> FunctionBuilder<Params, Returns>

where Params: TypedMultiValue, Returns: TypedMultiValue,

pub fn document(&mut self, doc: impl Into<Cow<'static, str>>) -> &mut Self

Set the doc comment for the function type

pub fn param<F>(&mut self, index: usize, generator: F) -> &mut Self

where F: Fn(&mut Param),

Update a parameter’s information given it’s position in the argument list

pub fn ret<F>(&mut self, index: usize, generator: F) -> &mut Self

where F: Fn(&mut Return),

Update a return type’s information given it’s position in the return list

Trait Implementations

impl<Params, Returns> Clone for FunctionBuilder<Params, Returns>

where Params: TypedMultiValue + Clone, Returns: TypedMultiValue + Clone,

fn clone(&self) -> FunctionBuilder<Params, Returns>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Params, Returns> Debug for FunctionBuilder<Params, Returns>

where Params: TypedMultiValue + Debug, Returns: TypedMultiValue + Debug,

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

Formats the value using the given formatter.

impl<Params, Returns> Default for FunctionBuilder<Params, Returns>

where Params: TypedMultiValue, Returns: TypedMultiValue,

fn default() -> Self

Returns the “default value” for a type.