Struct hooks::Effect

source ·

pub struct Effect<Dep: PartialEq, E: EffectFor<Dep>> { /* private fields */ }

Trait Implementations

source

impl<Dep: PartialEq, E: EffectFor<Dep>> Drop for Effect<Dep, E>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<Dep: PartialEq, E: EffectFor<Dep>> Hook<(E, Dep)> for Effect<Dep, E>

source

fn use_hook<'hook>(
 self: Pin<&'hook mut Self>,
 (effect, dep): (E, Dep)
) -> <Self as HookLifetime<'hook, (E, Dep)>>::Valuewhere
 Self: 'hook,

source

impl<Dep: PartialEq, E: EffectFor<Dep>> HookBounds for Effect<Dep, E>

type Bounds = Effect<Dep, E>

source

impl<'hook, Dep: PartialEq, E: EffectFor<Dep>> HookLifetime<'hook, (E, Dep), &'hook <Effect<Dep, E> as HookBounds>::Bounds> for Effect<Dep, E>

type Value = ()

source

impl<Dep: PartialEq, E: EffectFor<Dep>> HookPollNextUpdate for Effect<Dep, E>

source

fn poll_next_update(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<bool>

The meaning of the return value is: Read more

source

impl<Dep: PartialEq, E: EffectFor<Dep>> Unpin for Effect<Dep, E>

Auto Trait Implementations

impl<Dep, E> RefUnwindSafe for Effect<Dep, E>where
 Dep: RefUnwindSafe,
 E: RefUnwindSafe,
 <E as EffectFor<Dep>>::Cleanup: RefUnwindSafe,

impl<Dep, E> Send for Effect<Dep, E>where
 Dep: Send,
 E: Send,
 <E as EffectFor<Dep>>::Cleanup: Send,

impl<Dep, E> Sync for Effect<Dep, E>where
 Dep: Sync,
 E: Sync,
 <E as EffectFor<Dep>>::Cleanup: Sync,

impl<Dep, E> UnwindSafe for Effect<Dep, E>where
 Dep: UnwindSafe,
 E: UnwindSafe,
 <E as EffectFor<Dep>>::Cleanup: UnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<Args, H> HookExt<Args> for Hwhere
H: Hook<Args> + ?Sized,

source

fn use_hook(&mut self, args: Args) -> Self::Valuewhere
Self: Unpin,

A shortcut to call Hook::use_hook on Unpin hooks.

source

fn run_by_runner_with_get_args<'run, R, G>(
 &'run mut self,
 runner: R,
 get_args: G
) -> <R as RunHook<&'run mut Self, G, Args>>::RunningHookwhere
 R: RunHook<&'run mut Self, G, Args>,
 G: GetArgsForHook<R, &'run mut Self, Args>,
 Self: 'run + Unpin,

source

fn run_by_runner_with_clone_args<'run, R>(
 &'run mut self,
 runner: R,
 args: Args
) -> <R as RunHook<&'run mut Self, CloneArgsForHook<Args>, Args>>::RunningHookwhere
 R: RunHook<&'run mut Self, CloneArgsForHook<Args>, Args>,
 Self: 'run + Unpin,
 Args: Clone,

source

fn run_by_runner_with_default_args<'run, R>(
 &'run mut self,
 runner: R
) -> <R as RunHook<&'run mut Self, DefaultArgsForHook, Args>>::RunningHookwhere
 R: RunHook<&'run mut Self, DefaultArgsForHook, Args>,
 Self: 'run + Unpin,
 Args: Default,

source

fn run_with_get_args<'run, G>(
 &'run mut self,
 get_args: G
) -> RunningHook<&'run mut Self, G, Args>where
 G: GetArgsForHook<Runner, &'run mut Self, Args>,
 Self: 'run + Unpin,

source

fn run_with_clone_args<'run>(
 &'run mut self,
 args: Args
) -> RunningHook<&'run mut Self, CloneArgsForHook<Args>, Args>where
 Self: 'run + Unpin,
 Args: Clone,

source

fn run_with_default_args<'run>(
 &'run mut self
) -> RunningHook<&'run mut Self, DefaultArgsForHook, Args>where
 Self: 'run + Unpin,
 Args: Default,

source

fn into_run_by_runner_with_get_args<R, G>(
 self,
 runner: R,
 get_args: G
) -> <R as RunHook<Self, G, Args>>::RunningHookwhere
 R: RunHook<Self, G, Args>,
 G: GetArgsForHook<R, Self, Args>,
 Self: Sized,

source

fn into_run_by_runner_with_clone_args<R>(
 self,
 runner: R,
 args: Args
) -> <R as RunHook<Self, CloneArgsForHook<Args>, Args>>::RunningHookwhere
 R: RunHook<Self, CloneArgsForHook<Args>, Args>,
 Self: Sized,
 Args: Clone,

source

fn into_run_by_runner_with_default_args<R>(
 self,
 runner: R
) -> <R as RunHook<Self, DefaultArgsForHook, Args>>::RunningHookwhere
 R: RunHook<Self, DefaultArgsForHook, Args>,
 Self: Sized,
 Args: Default,

source

fn into_run_with_get_args<G>(self, get_args: G) -> RunningHook<Self, G, Args>where
G: GetArgsForHook<Runner, Self, Args>,
Self: Sized,

source

fn into_run_with_clone_args(
 self,
 args: Args
) -> RunningHook<Self, CloneArgsForHook<Args>, Args>where
 Self: Sized,
 Args: Clone,

source

fn into_run_with_default_args(
 self
) -> RunningHook<Self, DefaultArgsForHook, Args>where
 Self: Sized,
 Args: Default,

source

impl<H> HookPollNextUpdateExt for Hwhere
H: HookPollNextUpdate,

source

fn poll_next_update(&mut self, cx: &mut Context<'_>) -> Poll<bool>where
Self: Unpin,

A shortcut to call [Hook::poll_next_update] on Unpin hooks.

source

fn next_update(&mut self) -> NextUpdate<'_, Self>where
Self: Unpin,

Get a future which polls [Hook::poll_next_update].

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · 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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct hooks::Effect

Trait Implementations

impl<Dep: PartialEq, E: EffectFor<Dep>> Drop for Effect<Dep, E>

fn drop(&mut self)

impl<Dep: PartialEq, E: EffectFor<Dep>> Hook<(E, Dep)> for Effect<Dep, E>

fn use_hook<'hook>( self: Pin<&'hook mut Self>, (effect, dep): (E, Dep)) -> <Self as HookLifetime<'hook, (E, Dep)>>::Valuewhere Self: 'hook,

impl<Dep: PartialEq, E: EffectFor<Dep>> HookBounds for Effect<Dep, E>

type Bounds = Effect<Dep, E>

impl<'hook, Dep: PartialEq, E: EffectFor<Dep>> HookLifetime<'hook, (E, Dep), &'hook <Effect<Dep, E> as HookBounds>::Bounds> for Effect<Dep, E>

type Value = ()

impl<Dep: PartialEq, E: EffectFor<Dep>> HookPollNextUpdate for Effect<Dep, E>

fn poll_next_update(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<bool>

impl<Dep: PartialEq, E: EffectFor<Dep>> Unpin for Effect<Dep, E>

Auto Trait Implementations

impl<Dep, E> RefUnwindSafe for Effect<Dep, E>where Dep: RefUnwindSafe, E: RefUnwindSafe, <E as EffectFor<Dep>>::Cleanup: RefUnwindSafe,

impl<Dep, E> Send for Effect<Dep, E>where Dep: Send, E: Send, <E as EffectFor<Dep>>::Cleanup: Send,

impl<Dep, E> Sync for Effect<Dep, E>where Dep: Sync, E: Sync, <E as EffectFor<Dep>>::Cleanup: Sync,

impl<Dep, E> UnwindSafe for Effect<Dep, E>where Dep: UnwindSafe, E: UnwindSafe, <E as EffectFor<Dep>>::Cleanup: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<Args, H> HookExt<Args> for Hwhere H: Hook<Args> + ?Sized,

fn use_hook(&mut self, args: Args) -> Self::Valuewhere Self: Unpin,

fn run_by_runner_with_get_args<'run, R, G>( &'run mut self, runner: R, get_args: G) -> <R as RunHook<&'run mut Self, G, Args>>::RunningHookwhere R: RunHook<&'run mut Self, G, Args>, G: GetArgsForHook<R, &'run mut Self, Args>, Self: 'run + Unpin,

fn run_by_runner_with_clone_args<'run, R>( &'run mut self, runner: R, args: Args) -> <R as RunHook<&'run mut Self, CloneArgsForHook<Args>, Args>>::RunningHookwhere R: RunHook<&'run mut Self, CloneArgsForHook<Args>, Args>, Self: 'run + Unpin, Args: Clone,

fn run_by_runner_with_default_args<'run, R>( &'run mut self, runner: R) -> <R as RunHook<&'run mut Self, DefaultArgsForHook, Args>>::RunningHookwhere R: RunHook<&'run mut Self, DefaultArgsForHook, Args>, Self: 'run + Unpin, Args: Default,

fn run_with_get_args<'run, G>( &'run mut self, get_args: G) -> RunningHook<&'run mut Self, G, Args>where G: GetArgsForHook<Runner, &'run mut Self, Args>, Self: 'run + Unpin,

fn run_with_clone_args<'run>( &'run mut self, args: Args) -> RunningHook<&'run mut Self, CloneArgsForHook<Args>, Args>where Self: 'run + Unpin, Args: Clone,

fn run_with_default_args<'run>( &'run mut self) -> RunningHook<&'run mut Self, DefaultArgsForHook, Args>where Self: 'run + Unpin, Args: Default,

fn into_run_by_runner_with_get_args<R, G>( self, runner: R, get_args: G) -> <R as RunHook<Self, G, Args>>::RunningHookwhere R: RunHook<Self, G, Args>, G: GetArgsForHook<R, Self, Args>, Self: Sized,

fn into_run_by_runner_with_clone_args<R>( self, runner: R, args: Args) -> <R as RunHook<Self, CloneArgsForHook<Args>, Args>>::RunningHookwhere R: RunHook<Self, CloneArgsForHook<Args>, Args>, Self: Sized, Args: Clone,

fn into_run_by_runner_with_default_args<R>( self, runner: R) -> <R as RunHook<Self, DefaultArgsForHook, Args>>::RunningHookwhere R: RunHook<Self, DefaultArgsForHook, Args>, Self: Sized, Args: Default,

fn into_run_with_get_args<G>(self, get_args: G) -> RunningHook<Self, G, Args>where G: GetArgsForHook<Runner, Self, Args>, Self: Sized,

fn into_run_with_clone_args( self, args: Args) -> RunningHook<Self, CloneArgsForHook<Args>, Args>where Self: Sized, Args: Clone,

fn into_run_with_default_args( self) -> RunningHook<Self, DefaultArgsForHook, Args>where Self: Sized, Args: Default,

impl<H> HookPollNextUpdateExt for Hwhere H: HookPollNextUpdate,

fn poll_next_update(&mut self, cx: &mut Context<'_>) -> Poll<bool>where Self: Unpin,

fn next_update(&mut self) -> NextUpdate<'_, Self>where Self: Unpin,

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

fn use_hook<'hook>(
self: Pin<&'hook mut Self>,
(effect, dep): (E, Dep)
) -> <Self as HookLifetime<'hook, (E, Dep)>>::Valuewhere
Self: 'hook,

impl<Dep, E> RefUnwindSafe for Effect<Dep, E>where
Dep: RefUnwindSafe,
E: RefUnwindSafe,
<E as EffectFor<Dep>>::Cleanup: RefUnwindSafe,

impl<Dep, E> Send for Effect<Dep, E>where
Dep: Send,
E: Send,
<E as EffectFor<Dep>>::Cleanup: Send,

impl<Dep, E> Sync for Effect<Dep, E>where
Dep: Sync,
E: Sync,
<E as EffectFor<Dep>>::Cleanup: Sync,

impl<Dep, E> UnwindSafe for Effect<Dep, E>where
Dep: UnwindSafe,
E: UnwindSafe,
<E as EffectFor<Dep>>::Cleanup: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<Args, H> HookExt<Args> for Hwhere
H: Hook<Args> + ?Sized,

fn use_hook(&mut self, args: Args) -> Self::Valuewhere
Self: Unpin,

fn run_by_runner_with_get_args<'run, R, G>(
&'run mut self,
runner: R,
get_args: G
) -> <R as RunHook<&'run mut Self, G, Args>>::RunningHookwhere
R: RunHook<&'run mut Self, G, Args>,
G: GetArgsForHook<R, &'run mut Self, Args>,
Self: 'run + Unpin,

fn run_by_runner_with_clone_args<'run, R>(
&'run mut self,
runner: R,
args: Args
) -> <R as RunHook<&'run mut Self, CloneArgsForHook<Args>, Args>>::RunningHookwhere
R: RunHook<&'run mut Self, CloneArgsForHook<Args>, Args>,
Self: 'run + Unpin,
Args: Clone,

fn run_by_runner_with_default_args<'run, R>(
&'run mut self,
runner: R
) -> <R as RunHook<&'run mut Self, DefaultArgsForHook, Args>>::RunningHookwhere
R: RunHook<&'run mut Self, DefaultArgsForHook, Args>,
Self: 'run + Unpin,
Args: Default,

fn run_with_get_args<'run, G>(
&'run mut self,
get_args: G
) -> RunningHook<&'run mut Self, G, Args>where
G: GetArgsForHook<Runner, &'run mut Self, Args>,
Self: 'run + Unpin,

fn run_with_clone_args<'run>(
&'run mut self,
args: Args
) -> RunningHook<&'run mut Self, CloneArgsForHook<Args>, Args>where
Self: 'run + Unpin,
Args: Clone,

fn run_with_default_args<'run>(
&'run mut self
) -> RunningHook<&'run mut Self, DefaultArgsForHook, Args>where
Self: 'run + Unpin,
Args: Default,

fn into_run_by_runner_with_get_args<R, G>(
self,
runner: R,
get_args: G
) -> <R as RunHook<Self, G, Args>>::RunningHookwhere
R: RunHook<Self, G, Args>,
G: GetArgsForHook<R, Self, Args>,
Self: Sized,

fn into_run_by_runner_with_clone_args<R>(
self,
runner: R,
args: Args
) -> <R as RunHook<Self, CloneArgsForHook<Args>, Args>>::RunningHookwhere
R: RunHook<Self, CloneArgsForHook<Args>, Args>,
Self: Sized,
Args: Clone,

fn into_run_by_runner_with_default_args<R>(
self,
runner: R
) -> <R as RunHook<Self, DefaultArgsForHook, Args>>::RunningHookwhere
R: RunHook<Self, DefaultArgsForHook, Args>,
Self: Sized,
Args: Default,

fn into_run_with_get_args<G>(self, get_args: G) -> RunningHook<Self, G, Args>where
G: GetArgsForHook<Runner, Self, Args>,
Self: Sized,

fn into_run_with_clone_args(
self,
args: Args
) -> RunningHook<Self, CloneArgsForHook<Args>, Args>where
Self: Sized,
Args: Clone,

fn into_run_with_default_args(
self
) -> RunningHook<Self, DefaultArgsForHook, Args>where
Self: Sized,
Args: Default,

impl<H> HookPollNextUpdateExt for Hwhere
H: HookPollNextUpdate,

fn poll_next_update(&mut self, cx: &mut Context<'_>) -> Poll<bool>where
Self: Unpin,

fn next_update(&mut self) -> NextUpdate<'_, Self>where
Self: Unpin,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,