UseIntervalReturn

leptos_use

Struct UseIntervalReturn 

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

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§

Source§

impl<PauseFn, ResumeFn, ResetFn> UseIntervalReturn<PauseFn, ResumeFn, ResetFn>
where PauseFn: Fn() + Clone + Send + Sync, ResumeFn: Fn() + Clone + Send + Sync, ResetFn: Fn() + Clone + Send + Sync,

Source

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

Counter signal that increases by one every interval.

Source

pub fn reset<New__ResetFn>( self, value: New__ResetFn, ) -> UseIntervalReturn<PauseFn, ResumeFn, New__ResetFn>
where PauseFn: Fn() + Clone + Send + Sync, ResumeFn: Fn() + Clone + Send + Sync, New__ResetFn: Fn() + Clone + Send + Sync,

Reset the counter to zero

Source

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

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

Source

pub fn pause<New__PauseFn>( self, value: New__PauseFn, ) -> UseIntervalReturn<New__PauseFn, ResumeFn, ResetFn>
where New__PauseFn: Fn() + Clone + Send + Sync, ResumeFn: Fn() + Clone + Send + Sync, ResetFn: Fn() + Clone + Send + Sync,

Temporarily pause the counter

Source

pub fn resume<New__ResumeFn>( self, value: New__ResumeFn, ) -> UseIntervalReturn<PauseFn, New__ResumeFn, ResetFn>
where PauseFn: Fn() + Clone + Send + Sync, New__ResumeFn: Fn() + Clone + Send + Sync, ResetFn: Fn() + Clone + Send + Sync,

Resume the counter

Auto Trait Implementations§

§

impl<PauseFn, ResumeFn, ResetFn> Freeze for UseIntervalReturn<PauseFn, ResumeFn, ResetFn>
where ResetFn: Freeze, PauseFn: Freeze, ResumeFn: Freeze,

§

impl<PauseFn, ResumeFn, ResetFn> RefUnwindSafe for UseIntervalReturn<PauseFn, ResumeFn, ResetFn>
where ResetFn: RefUnwindSafe, PauseFn: RefUnwindSafe, ResumeFn: RefUnwindSafe,

§

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

§

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

§

impl<PauseFn, ResumeFn, ResetFn> Unpin for UseIntervalReturn<PauseFn, ResumeFn, ResetFn>
where ResetFn: Unpin, PauseFn: Unpin, ResumeFn: Unpin,

§

impl<PauseFn, ResumeFn, ResetFn> UnwindSafe for UseIntervalReturn<PauseFn, ResumeFn, ResetFn>
where ResetFn: UnwindSafe, PauseFn: UnwindSafe, ResumeFn: 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<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<El, T, Marker> IntoElementMaybeSignal<T, Marker> for El
where El: IntoElementMaybeSignalType<T, Marker>, Marker: ?Sized,

Source§

fn into_element_maybe_signal(self) -> ElementMaybeSignal<T>

Source§

impl<T, Js> IntoElementMaybeSignalType<T, Element> for Js
where T: From<Js> + Clone,

Source§

fn into_element_maybe_signal_type(self) -> ElementMaybeSignalType<T>

Source§

impl<El, T, Marker> IntoElementsMaybeSignal<T, Marker> for El
where El: IntoElementsMaybeSignalType<T, Marker>, Marker: ?Sized,

Source§

fn into_elements_maybe_signal(self) -> ElementsMaybeSignal<T>

Source§

impl<T, Js> IntoElementsMaybeSignalType<T, Element> for Js
where T: From<Js> + Clone,

Source§

fn into_elements_maybe_signal_type(self) -> ElementsMaybeSignalType<T>

Source§

impl<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<T> SerializableKey for T

Source§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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.
Source§

impl<T> ErasedDestructor for T
where T: 'static,