Struct aide::transform::TransformParameter

pub struct TransformParameter<'t, T> { /* private fields */ }

A transform helper that wraps Parameter.

An additional type is provided for strongly-typed examples.

Implementations

impl<'t, T> TransformParameter<'t, T>

pub fn new(param: &'t mut Parameter) -> Self

Create a new transform helper.

pub fn hidden(self, hidden: bool) -> Self

Hide the parameter from the documentation.

This is taken into account by generators provided by this library.

Hiding an item causes it to be ignored completely, there is no way to restore or “unhide” it afterwards.

pub fn description(self, desc: &str) -> Self

Provide or override the description of the parameter.

pub fn with(self, transform: impl FnOnce(Self) -> Self) -> Self

Apply an another transform function.

pub fn inner_mut(&mut self) -> &mut Parameter

Access the inner Parameter.