Struct ArgBuilder

pub struct ArgBuilder<'r, 'a, T> { /* private fields */ }

Builder for providing additional argument information for error reporting.

Implementations

impl<'r, 'a, T> ArgBuilder<'r, 'a, T>

pub fn with_name<S: Into<Cow<'a, str>>>(self, name: S) -> Self

Provides a name for this argument. If an old name is already set, it is silently replaced. The name can either be borrowed from the environment or owned.

pub fn with_type_name<S: Into<Cow<'a, str>>>(self, ty: S) -> Self

Provides a more readable type name for this argument. If an old name is already set, it is silently replaced. If no type name is given, a value from std::any::type_name is used. The name can either be borrowed from the environment or owned.

pub fn with_site(self, site: Site<'a>) -> Self

Provides a call site for this argument. If an old call site is already set, it is silently replaced. If given, the site will be used in case of error.

impl<'r, 'a, T: FromVariant> ArgBuilder<'r, 'a, T>

pub fn get(self) -> Result<T, ArgumentError<'a>>

Get the converted argument value.

Errors

If the argument is missing, or cannot be converted to the desired type.

pub fn get_optional(self) -> Result<Option<T>, ArgumentError<'a>>

Get the argument as optional.

Errors

If the argument is present, but cannot be converted to the desired type.