pub struct WebSocketConn { /* private fields */ }
Expand description

A struct that represents an specific websocket connection.

This can be thought of as a combination of a [async_tungstenite::WebSocketStream] and a trillium::Conn, as it contains a combination of their fields and associated functions.

The WebSocketConn implements Stream<Item=Result<Message, Error>>, and can be polled with StreamExt::next

Implementations

send a Message::Text variant

send a Message::Binary variant

Sends a Message to the client

retrieve a clone of the server’s [Stopper]

close the websocket connection gracefully

retrieve the request headers for this conn

retrieves the path part of the request url, up to and excluding any query component

Retrieves the query component of the path, excluding ?. Returns an empty string if there is no query component.

retrieve the request method for this conn

retrieve state from the state set that has been accumulated by trillium handlers run on the trillium::Conn before it became a websocket. see trillium::Conn::state for more information

retrieve a mutable borrow of the state from the state set

set state on this connection

take some type T out of the state set that has been accumulated by trillium handlers run on the trillium::Conn before it became a websocket. see trillium::Conn::take_state for more information

take the inbound Message stream from this conn

borrow the inbound Message stream from this conn

Trait Implementations

Converts this type into a mutable reference of the (usually inferred) input type.

Converts this type into a shared reference of the (usually inferred) input type.

Formats the value using the given formatter. Read more

Values yielded by the stream.

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more

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

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

A convenience for calling [Stream::poll_next()] on !Unpin types.

Retrieves the next item in the stream. Read more

Retrieves the next item in the stream. Read more

Counts the number of items in the stream. Read more

Maps items of the stream to new values using a closure. Read more

Maps items to streams and then concatenates them. Read more

Concatenates inner streams. Read more

Maps items of the stream to new values using an async closure. Read more

Keeps items of the stream for which predicate returns true. Read more

Filters and maps items of the stream using a closure. Read more

Takes only the first n items of the stream. Read more

Takes items while predicate returns true. Read more

Skips the first n items of the stream. Read more

Skips items while predicate returns true. Read more

Yields every stepth item. Read more

Appends another stream to the end of this one. Read more

Clones all items. Read more

Copies all items. Read more

Collects all items in the stream into a collection. Read more

Collects all items in the fallible stream into a collection. Read more

Partitions items into those for which predicate is true and those for which it is false, and then collects them into two collections. Read more

Accumulates a computation over the stream. Read more

Accumulates a fallible computation over the stream. Read more

Maps items of the stream to new values using a state value and a closure. Read more

Fuses the stream so that it stops yielding items after the first None. Read more

Repeats the stream from beginning to end, forever. Read more

Enumerates items, mapping them to (index, item). Read more

Calls a closure on each item and passes it on. Read more

Gets the nth item of the stream. Read more

Returns the last item in the stream. Read more

Finds the first item of the stream for which predicate returns true. Read more

Applies a closure to items in the stream and returns the first Some result. Read more

Finds the index of the first item of the stream for which predicate returns true. Read more

Tests if predicate returns true for all items in the stream. Read more

Tests if predicate returns true for any item in the stream. Read more

Calls a closure on each item of the stream. Read more

Calls a fallible closure on each item of the stream, stopping on first error. Read more

Zips up two streams into a single stream of pairs. Read more

Collects a stream of pairs into a pair of collections. Read more

Merges with other stream, preferring items from self whenever both streams are ready. Read more

Merges with other stream, with no preference for either stream when both are ready. Read more

Boxes the stream and changes its type to dyn Stream + Send + 'a. Read more

Boxes the stream and changes its type to dyn Stream + 'a. 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

Drives the stream to completion, counting the number of items. 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

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

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

Maps a stream like [StreamExt::map] but flattens nested Streams and polls them concurrently, yielding items in any order, as they made available. 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

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.

The type of successful values yielded by this future

The type of failures yielded by this future

Poll this TryStream as if it were a Stream. Read more

Wraps the current stream in a new stream which converts the error type into the one provided. Read more

Wraps the current stream in a new stream which maps the success value using the provided closure. Read more

Wraps the current stream in a new stream which maps the error value using the provided closure. Read more

Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more

Do something with the success value of this stream, afterwards passing it on. Read more

Do something with the error value of this stream, afterwards passing it on. Read more

Wraps a [TryStream] into a type that implements Stream Read more

Creates a future that attempts to resolve the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

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

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

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

Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available, exiting as soon as an error occurs. Read more

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

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

Attempt to filter the values produced by this stream according to the provided asynchronous closure. Read more

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

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

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

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

Attempt to execute several futures from a stream concurrently (unordered). Read more

Attempt to execute several futures from a stream concurrently. Read more

A convenience method for calling [TryStream::try_poll_next] on Unpin stream types. Read more

Adapter that converts this stream into an AsyncRead. Read more