Struct Session

pub struct Session<S> { /* private fields */ }

Implementations§

impl<S> Session<S>

pub fn new( io: S, data_producer: DataProducer, publish_request_producer: PublishProducer, ) -> Self

pub fn uid(&self) -> Option<UniqueID>

impl<S: AsyncRead + AsyncWrite + Unpin> Session<S>

pub async fn run(&mut self) -> Result<bool, SessionError>

Run the session to completion The result of the return value will be true if all publishers have disconnected If any publishers are still connected, the result will be false This can be used to detect non-graceful disconnects (ie. the client crashed)

Auto Trait Implementations§

impl<S> Freeze for Session<S>
where S: Freeze,

impl<S> RefUnwindSafe for Session<S>
where S: RefUnwindSafe,

impl<S> Send for Session<S>
where S: Send,

impl<S> Sync for Session<S>
where S: Sync,

impl<S> Unpin for Session<S>
where S: Unpin,

impl<S> UnwindSafe for Session<S>
where S: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T
where 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>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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