Skip to main content

Driver

Struct Driver 

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

Pumps a session over a transport.

One step flushes everything the session wants to send, then waits for whichever comes first: an inbound frame, the session’s next deadline, or the keep-alive interval. The application keeps the loop, and with it the freedom to do anything else between steps.

Implementations§

Source§

impl<T: TextTransport> Driver<T>

Source

pub fn new(transport: T) -> Self

A driver over this transport.

Source

pub fn with_clock(self, now: fn() -> Timestamp) -> Self

Use a different clock — a virtual one, in a test.

Source

pub fn with_ping_interval(self, interval: Duration) -> Self

Send pings at a different interval. S2 Connect allows up to sixty seconds.

Source

pub fn transport_mut(&mut self) -> &mut T

The transport, for a caller that wants to close it itself.

Source

pub async fn step<S: Session>(&mut self, session: &mut S) -> Result<(), Error>

Run one step of a session, whichever role it is.

Flush, wait for the first of {a frame, the session’s deadline, the keep-alive interval}, feed the result back in, flush again. Everything that decides anything is in the session; this function decides only what to wait on.

Source

pub async fn run<S, F>( &mut self, session: &mut S, on_event: F, ) -> Result<(), Error>
where S: Session, F: FnMut(S::Event, &mut S),

Run a session to completion: steps until it closes.

The application still sees every event, through the callback, but no longer owns the loop. For anything that wants to do other work between steps, use Self::step.

Auto Trait Implementations§

§

impl<T> Forget for Driver<T>

§

impl<T> Freeze for Driver<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Driver<T>
where T: RefUnwindSafe,

§

impl<T> Send for Driver<T>
where T: Send,

§

impl<T> Sync for Driver<T>
where T: Sync,

§

impl<T> Unpin for Driver<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Driver<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Driver<T>
where T: UnwindSafe,

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