Struct tokio_xmpp::AsyncClient[][src]

pub struct AsyncClient { /* fields omitted */ }
Expand description

XMPP client connection and state

It is able to reconnect. TODO: implement session management.

This implements the futures crate’s Stream and Sink traits.

Implementations

Start a new XMPP client

Start polling the returned instance so that it will connect and yield events.

Start a new client given that the JID is already parsed.

Set whether to reconnect (true) or let the stream end (false) when a connection to the server has ended.

Get the client’s bound JID (the one reported by the XMPP server).

Send stanza

End connection by sending </stream:stream>

You may expect the server to respond with the same. This client will then drop its connection.

Make sure to disable reconnect.

Trait Implementations

Outgoing XMPP packets

See send_stanza() for an async fn

The type of value produced by the sink when an error occurs.

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())). Read more

Attempts to prepare the Sink to receive a value. Read more

Flush any remaining output from this sink. Read more

Flush any remaining output and close this sink, if necessary. Read more

Incoming XMPP events

In an async fn you may want to use this with use futures::stream::StreamExt;

Low-level read on the XMPP stream, allowing the underlying machinery to:

  • connect,
  • starttls,
  • authenticate,
  • bind a session, and finally
  • receive stanzas

…for your client

Values yielded by the stream.

Returns the bounds on the remaining length of the stream. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

Should always be Self

Composes a function in front of the sink. Read more

Composes a function in front of the sink. Read more

Transforms the error returned by the sink.

Map this sink’s error to a different error type using the Into trait. Read more

Adds a fixed-size buffer to the current sink. Read more

Close the sink.

Fanout items to multiple sinks. Read more

Flush the sink, processing all pending items. Read more

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

A future that completes after the given item has been received by the sink. Read more

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

A convenience method for calling [Sink::poll_ready] on Unpin sink types. Read more

A convenience method for calling [Sink::start_send] on Unpin sink types. Read more

A convenience method for calling [Sink::poll_flush] on Unpin sink types. Read more

A convenience method for calling [Sink::poll_close] on Unpin sink types. Read more

Creates a future that resolves to the next item in the stream. Read more

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is None. Read more

Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more

Creates a stream which gives the current iteration count as well as the next value. Read more

Filters the values produced by this stream according to the provided asynchronous predicate. Read more

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

Computes from this stream’s items new items of a different type using an asynchronous closure. Read more

Transforms a stream into a collection, returning a future representing the result of that computation. Read more

Converts a stream of pairs into a future, which resolves to pair of containers. Read more

Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

Repeats a stream endlessly. Read more

Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

Execute predicate over asynchronous stream, and return true if any element in stream satisfied a predicate. Read more

Execute predicate over asynchronous stream, and return true if all element in stream satisfied a predicate. Read more

Flattens a stream of streams into just one continuous stream. Read more

Maps a stream like [StreamExt::map] but flattens nested Streams. Read more

Combinator similar to [StreamExt::fold] that holds internal state and produces a new stream. Read more

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

Take elements from this stream while the provided asynchronous predicate resolves to true. Read more

Take elements from this stream until the provided future resolves. Read more

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more

Creates a new stream of at most n items of the underlying stream. Read more

Creates a new stream which skips n items of the underlying stream. Read more

Fuse a stream such that poll_next will never again be called once it has finished. This method can be used to turn any Stream into a FusedStream. Read more

Borrows a stream, rather than consuming it. Read more

Catches unwinding panics while polling the stream. Read more

Wrap the stream in a Box, pinning it. Read more

Wrap the stream in a Box, pinning it. Read more

An adaptor for creating a buffered list of pending futures. Read more

An adaptor for creating a buffered list of pending futures (unordered). Read more

An adapter for zipping two streams together. Read more

Adapter for chaining two streams. Read more

Creates a new stream which exposes a peek method. Read more

An adaptor for chunking up items of the stream inside a vector. Read more

An adaptor for chunking up ready items of the stream inside a vector. Read more

A future that completes after the given stream has been fully processed into the sink and the sink has been flushed and closed. Read more

Splits this Stream + Sink object into separate Sink and Stream objects. Read more

Do something with each item of this stream, afterwards passing it on. Read more

Wrap this stream in an Either stream, making it the left-hand variant of that Either. Read more

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

A convenience method for calling [Stream::poll_next] on Unpin stream types. Read more

Returns a Future that resolves when the next item in this stream is ready. Read more

Consumes and returns the next value in the stream or None if the stream is finished. Read more

Consumes and returns the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more

Combine two streams into one by interleaving the output of both as it is produced. Read more

Filters the values produced by this stream according to the provided predicate. Read more

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided closure. Read more

Creates a stream which ends after the first None. Read more

Creates a new stream of at most n items of the underlying stream. Read more

Take elements from this stream while the provided predicate resolves to true. Read more

Creates a new stream that will skip the n first items of the underlying stream. Read more

Skip elements from the underlying stream while the provided predicate resolves to true. Read more

Tests if every element of the stream matches a predicate. Read more

Tests if any element of the stream matches a predicate. Read more

Combine two streams into one by first returning all values from the first stream then all values from the second stream. Read more

A combinator that applies a function to every element in a stream producing a single, final value. Read more

Drain stream pushing all emitted values into a collection. Read more

Applies a per-item timeout to the passed stream. Read more

Slows down a stream by enforcing a delay between items. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.