Struct leptos_use::UseIntervalReturn

pub struct UseIntervalReturn<PauseFn, ResumeFn, ResetFn>
where
    PauseFn: Fn() + Clone,
    ResumeFn: Fn() + Clone,
    ResetFn: Fn() + Clone,
{
    pub counter: Signal<u64>,
    pub reset: ResetFn,
    pub is_active: Signal<bool>,
    pub pause: PauseFn,
    pub resume: ResumeFn,
}

Return type of use_interval.

Fields

counter: Signal<u64>

Counter signal that increases by one every interval.

reset: ResetFn

Reset the counter to zero

is_active: Signal<bool>

A Signal that indicates whether the counter is active. false when paused.

pause: PauseFn

Temporarily pause the counter

resume: ResumeFn

Resume the counter

Implementations

impl<PauseFn, ResumeFn, ResetFn> UseIntervalReturn<PauseFn, ResumeFn, ResetFn>

where PauseFn: Fn() + Clone, ResumeFn: Fn() + Clone, ResetFn: Fn() + Clone,

pub fn counter(self, value: Signal<u64>) -> Self

Counter signal that increases by one every interval.

pub fn reset<New__ResetFn>( self, value: New__ResetFn, ) -> UseIntervalReturn<PauseFn, ResumeFn, New__ResetFn>

where PauseFn: Fn() + Clone, ResumeFn: Fn() + Clone, New__ResetFn: Fn() + Clone,

Reset the counter to zero

pub fn is_active(self, value: Signal<bool>) -> Self

A Signal that indicates whether the counter is active. false when paused.

pub fn pause<New__PauseFn>( self, value: New__PauseFn, ) -> UseIntervalReturn<New__PauseFn, ResumeFn, ResetFn>

where New__PauseFn: Fn() + Clone, ResumeFn: Fn() + Clone, ResetFn: Fn() + Clone,

Temporarily pause the counter

pub fn resume<New__ResumeFn>( self, value: New__ResumeFn, ) -> UseIntervalReturn<PauseFn, New__ResumeFn, ResetFn>

where PauseFn: Fn() + Clone, New__ResumeFn: Fn() + Clone, ResetFn: Fn() + Clone,

Resume the counter