[−][src]Struct ws_stream_wasm::WsMeta
The meta data related to a websocket. Allows access to the methods on the WebSocket API.
This is split from the Stream
/Sink
so you can pass the latter to a combinator whilst
continuing to use this API.
A WsMeta
instance is observable through the pharos::Observable
trait. The type of event is WsEvent. In the case of a Close event, there will be additional information included
as a CloseEvent.
When you drop this, the connection does not get closed, however when you drop WsStream it does.
Most of the methods on this type directly map to the web API. For more documentation, check the MDN WebSocket documentation.
WsMeta
exists so you can pass WsStream to combinators that consume the Stream
, yet still allow you
to access the API of the underlying WebSocket.
Implementations
impl WsMeta
[src]
pub async fn connect<'_>(
url: impl AsRef<str>,
protocols: impl Into<Option<Vec<&'_ str>>>
) -> Result<(Self, WsStream), WsErr>
[src]
url: impl AsRef<str>,
protocols: impl Into<Option<Vec<&'_ str>>>
) -> Result<(Self, WsStream), WsErr>
Connect to the server. The future will resolve when the connection has been established with a successful WebSocket handshake.
This returns both a WsMeta (allow manipulating and requesting meta data for the connection) and
a WsStream (Stream
/Sink
over WsMessage). WsStream can be wrapped to obtain
AsyncRead
/AsyncWrite
/AsyncBufRead
with WsStream::into_io.
Errors
Browsers will forbid making websocket connections to certain ports. See this Stack Overflow question.
connect
will return a WsErr::ForbiddenPort.
If the URL is invalid, a WsErr::InvalidUrl is returned. See the HTML Living Standard for more information.
When the connection fails (server port not open, wrong ip, wss:// on ws:// server, ... See the HTML Living Standard for details on all failure possibilities), a WsErr::ConnectionFailed is returned.
Note: Sending protocols to a server that doesn't support them will make the connection fail.
pub async fn close<'_>(&'_ self) -> Result<CloseEvent, WsErr>
[src]
Close the socket. The future will resolve once the socket's state has become WsState::CLOSED
.
See: MDN Documentation
pub async fn close_code<'_>(&'_ self, code: u16) -> Result<CloseEvent, WsErr>
[src]
Close the socket. The future will resolve once the socket's state has become WsState::CLOSED
.
See: MDN Documentation
pub async fn close_reason<'_>(
&'_ self,
code: u16,
reason: impl AsRef<str>
) -> Result<CloseEvent, WsErr>
[src]
&'_ self,
code: u16,
reason: impl AsRef<str>
) -> Result<CloseEvent, WsErr>
Close the socket. The future will resolve once the socket's state has become WsState::CLOSED
.
See: MDN Documentation
pub fn ready_state(&self) -> WsState
[src]
Verify the WsState of the connection.
pub fn wrapped(&self) -> &WebSocket
[src]
Access the wrapped web_sys::WebSocket directly.
ws_stream_wasm tries to expose all useful functionality through an idiomatic rust API, so hopefully you won't need this, however if I missed something, you can.
Caveats
If you call set_onopen
, set_onerror
, set_onmessage
or set_onclose
on this, you will overwrite
the event listeners from ws_stream_wasm
, and things will break.
pub fn buffered_amount(&self) -> u32
[src]
The number of bytes of data that have been queued but not yet transmitted to the network.
NOTE: that this is the number of bytes buffered by the underlying platform WebSocket implementation. It does not reflect any buffering performed by ws_stream_wasm.
pub fn extensions(&self) -> String
[src]
The extensions selected by the server as negotiated during the connection.
NOTE: This is an untested feature. The back-end server we use for testing (tungstenite) does not support Extensions.
pub fn protocol(&self) -> String
[src]
The name of the sub-protocol the server selected during the connection.
This will be one of the strings specified in the protocols parameter when creating this WsMeta instance.
pub fn url(&self) -> String
[src]
Retrieve the address to which this socket is connected.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for WsMeta
impl Send for WsMeta
impl Sync for WsMeta
impl Unpin for WsMeta
impl !UnwindSafe for WsMeta
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,