Struct gloo::net::websocket::futures::WebSocket

pub struct WebSocket { /* private fields */ }

Available on crate features net and websocket only.

Wrapper around browser’s WebSocket API.

Implementations

impl WebSocket

pub fn open(url: &str) -> Result<WebSocket, JsError>

Establish a WebSocket connection.

This function may error in the following cases:

• The port to which the connection is being attempted is being blocked.
• The URL is invalid.

The error returned is JsError. See the MDN Documentation to learn more.

pub fn open_with_protocol( url: &str, protocol: &str ) -> Result<WebSocket, JsError>

Establish a WebSocket connection.

This function may error in the following cases:

• The port to which the connection is being attempted is being blocked.
• The URL is invalid.
• The specified protocol is not supported

The error returned is JsError. See the MDN Documentation to learn more.

pub fn open_with_protocols<S>( url: &str, protocols: &[S] ) -> Result<WebSocket, JsError>where S: AsRef<str> + Serialize,

Available on crate feature json only.

Establish a WebSocket connection.

This function may error in the following cases:

• The port to which the connection is being attempted is being blocked.
• The URL is invalid.
• The specified protocols are not supported
• The protocols cannot be converted to a JSON string list

The error returned is JsError. See the MDN Documentation to learn more.

This function requires json features because protocols are parsed by serde into JsValue.

pub fn close( self, code: Option<u16>, reason: Option<&str> ) -> Result<(), JsError>

Closes the websocket.

See the MDN Documentation to learn about parameters passed to this function and when it can return an Err(_)

pub fn state(&self) -> State

The current state of the websocket.

pub fn extensions(&self) -> String

The extensions in use.

pub fn protocol(&self) -> String

The sub-protocol in use.

Trait Implementations

impl Drop for WebSocket

fn drop(&mut self)

Executes the destructor for this type.

impl Sink<Message> for WebSocket

type Error = WebSocketError

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

fn poll_ready( self: Pin<&mut WebSocket>, cx: &mut Context<'_> ) -> Poll<Result<(), <WebSocket as Sink<Message>>::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut WebSocket>, item: Message ) -> Result<(), <WebSocket as Sink<Message>>::Error>

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(())).

fn poll_flush( self: Pin<&mut WebSocket>, _cx: &mut Context<'_> ) -> Poll<Result<(), <WebSocket as Sink<Message>>::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut WebSocket>, _cx: &mut Context<'_> ) -> Poll<Result<(), <WebSocket as Sink<Message>>::Error>>

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

impl Stream for WebSocket

type Item = Result<Message, WebSocketError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut WebSocket>, cx: &mut Context<'_> ) -> Poll<Option<<WebSocket as Stream>::Item>>

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.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin> Unpin for WebSocketwhere __WebSocket<'pin>: Unpin,