Struct StatefulListener

#[non_exhaustive]
pub struct StatefulListener<St, Assf, Sf, Hauf> {
    pub state: St,
    pub stream: Assf,
    pub stop_token: Sf,
    pub hint_allowed_updates: Option<Hauf>,
}

A listener created from functions.

This type allows to turn a stream of updates (+ some additional functions) into an UpdateListener.

For an example of usage, see Polling.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

state: St

The state of the listener.

stream: Assf

The function used as AsUpdateStream::as_stream.

Must implement for<'a> FnMut(&'a mut St) -> impl Stream + 'a.

stop_token: Sf

The function used as UpdateListener::stop_token.

Must implement FnMut(&mut St) -> StopToken.

hint_allowed_updates: Option<Hauf>

The function used as UpdateListener::hint_allowed_updates.

Must implement FnMut(&mut St, &mut dyn Iterator<Item = AllowedUpdate>).

Implementations

impl<St, Assf, Sf> StatefulListener<St, Assf, Sf, for<'a, 'b> fn(&'a mut St, &'b mut dyn Iterator<Item = AllowedUpdate>)>

pub fn new(state: St, stream: Assf, stop_token: Sf) -> Self

Creates a new stateful listener from its components.

impl<St, Assf, Sf, Hauf> StatefulListener<St, Assf, Sf, Hauf>

pub fn new_with_hints( state: St, stream: Assf, stop_token: Sf, hint_allowed_updates: Option<Hauf>, ) -> Self

Creates a new stateful listener from its components.

Trait Implementations

impl<'a, St, Assf, Sf, Hauf, Strm, E> AsUpdateStream<'a> for StatefulListener<St, Assf, Hauf, Sf>

where (St, Strm): 'a, Strm: Send + Stream<Item = Result<Update, E>>, Assf: FnMut(&'a mut St) -> Strm,

type StreamErr = E

Error that can be returned from the Stream

type Stream = Strm

The stream of updates from Telegram.

fn as_stream(&'a mut self) -> Self::Stream

Creates the update Stream.

impl<St, Assf, Sf, Hauf, E> UpdateListener for StatefulListener<St, Assf, Sf, Hauf>

where Self: for<'a> AsUpdateStream<'a, StreamErr = E>, Sf: FnMut(&mut St) -> StopToken, Hauf: FnMut(&mut St, &mut dyn Iterator<Item = AllowedUpdate>),

type Err = E

The type of errors that can be returned from this listener.

fn stop_token(&mut self) -> StopToken

Returns a token which stops this listener.

fn hint_allowed_updates( &mut self, hint: &mut dyn Iterator<Item = AllowedUpdate>, )

Hint which updates should the listener listen for.