HookConstruction

Struct HookConstruction 

Source
pub struct HookConstruction<CurrentStores: StoresList, EntireStores: StoresList> { /* private fields */ }
Expand description

This is the consecuit or cc object in your hook function.

You can use it to call other hooks.

You must return it at the end of your hook function. (See the doc at crate on how to write hooks).

Implementations§

Source§

impl<ThisStore, RestStores, EntireStores> HookConstruction<StoreCons<ThisStore, RestStores>, EntireStores>
where ThisStore: StoresList, RestStores: StoresList, EntireStores: StoresList,

Source

pub fn hook<Arg, Out, Ret>( self, hook_func: fn(HookBuilder, Arg) -> Ret, hook_arg: Arg, ) -> (HookConstruction<RestStores, EntireStores>, Out)
where Ret: HookReturn<Out, StoresList = ThisStore>,

Use the given hook, with the given arg.

Consumes self. Returns a tuple of (cc, <return value of hook>). You can use the returned cc to call more hooks.

See the docs at crate for more info on how to write and use hooks.

Auto Trait Implementations§

§

impl<CurrentStores, EntireStores> Freeze for HookConstruction<CurrentStores, EntireStores>

§

impl<CurrentStores, EntireStores> !RefUnwindSafe for HookConstruction<CurrentStores, EntireStores>

§

impl<CurrentStores, EntireStores> !Send for HookConstruction<CurrentStores, EntireStores>

§

impl<CurrentStores, EntireStores> !Sync for HookConstruction<CurrentStores, EntireStores>

§

impl<CurrentStores, EntireStores> Unpin for HookConstruction<CurrentStores, EntireStores>
where EntireStores: Unpin,

§

impl<CurrentStores, EntireStores> !UnwindSafe for HookConstruction<CurrentStores, EntireStores>

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> Same for T

Source§

type Output = T

Should always be Self
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.