Skip to main content

PassDecorator

Struct PassDecorator 

Source
pub struct PassDecorator<T> { /* private fields */ }
Expand description

A decorator factory for passing a context object of type T to a callback.

Create one with make_pass_decorator, then call PassDecorator::decorate to wrap a function that expects &T.

This matches the most common Click usage (ensure = false). Unlike Python, click-rs callbacks receive &Context (not &mut Context), so this helper does not support “ensure” semantics that would create and store an object if it is missing.

Implementations§

Source§

impl<T: 'static> PassDecorator<T>

Source

pub fn decorate<F>(self, f: F) -> CommandCallback
where F: Fn(&T, &Context) -> Result<()> + Send + Sync + 'static,

Wrap a function that expects &T into a click-rs CommandCallback.

Auto Trait Implementations§

§

impl<T> Freeze for PassDecorator<T>

§

impl<T> RefUnwindSafe for PassDecorator<T>
where T: RefUnwindSafe,

§

impl<T> Send for PassDecorator<T>
where T: Send,

§

impl<T> Sync for PassDecorator<T>
where T: Sync,

§

impl<T> Unpin for PassDecorator<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for PassDecorator<T>

§

impl<T> UnwindSafe for PassDecorator<T>
where T: 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.