Skip to main content

WebSocket

Struct WebSocket 

Source
pub struct WebSocket<S> { /* private fields */ }
Available on crate feature tokio only.
Expand description

A WebSocket, as S2 Connect specifies it.

Implementations§

Source§

impl WebSocket<MaybeTlsStream<TcpStream>>

Source

pub async fn connect(url: &str, bearer: Option<&str>) -> Result<Self, Error>

Connect to a URL, with the bearer token S2 Connect’s session initiation issued.

S2C §Authentication: “the client must authenticate itself using the commToken in the authorization header of the websocket connection request”.

TLS is verified against the public PKI, which is right for a WAN endpoint and wrong for a LAN one: a wss://EVSE1038.local/s2 certificate is self-signed, and what makes it trustworthy is the CA pinned during pairing. Use connect_with_policy there.

Source

pub async fn open( url: &str, options: &WebSocketOptions<'_>, ) -> Result<Self, Error>

Connect with everything spelled out: bearer, size cap and TLS policy.

A wss:// dial always supplies its own Connector::Rustls, built from default_provider: the application’s provider if it installed one, this build’s otherwise, and an Error::Transport rather than a panic when there is none. Letting rustls resolve its own provider panics when no provider feature is on and panics again when two are (D52).

Source

pub async fn connect_with_policy( url: &str, bearer: Option<&str>, policy: &TlsPolicy, ) -> Result<Self, Error>

Connect under a TlsPolicy — which, after a LAN pairing, is the CA that pairing pinned.

This is the one to use in a LAN, with the policy connect::client::Paired::policy returns. The session initiation that produced the communication token ran against the pinned CA; connecting the WebSocket against a bundled root list instead would either fail outright — which is what it does — or, worse, succeed against a different server.

let socket = WebSocket::connect_with_policy(url, Some(token), policy).await?;
Source§

impl<S> WebSocket<S>

Source

pub fn from_stream(stream: WebSocketStream<S>) -> Self

Wrap an already-established WebSocket — one a server accepted, for instance.

Trait Implementations§

Source§

impl<S> TextTransport for WebSocket<S>
where S: AsyncRead + AsyncWrite + Unpin + Send,

Source§

async fn send_text(&mut self, text: String) -> Result<(), Error>

Send one message.
Source§

async fn recv_text(&mut self) -> Result<Option<String>, Error>

Wait for one message. None when the peer closed cleanly. Read more
Source§

async fn recv(&mut self) -> Result<Option<Received>, Error>

Wait for one frame, reporting the ones that only prove the peer is alive — a pong, a ping — as Received::Alive. Read more
Source§

async fn ping(&mut self) -> Result<(), Error>

Send a keep-alive, if the transport has one.
Source§

async fn close(&mut self)

Close.

Auto Trait Implementations§

§

impl<S> !Freeze for WebSocket<S>

§

impl<S> !RefUnwindSafe for WebSocket<S>

§

impl<S> !UnwindSafe for WebSocket<S>

§

impl<S> Forget for WebSocket<S>

§

impl<S> Move for WebSocket<S>

§

impl<S> Send for WebSocket<S>

§

impl<S> Sync for WebSocket<S>

§

impl<S> Unpin for WebSocket<S>

§

impl<S> UnsafeUnpin for WebSocket<S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more