Struct io::IoContext

source ·
pub struct IoContext<Message>
where Message: Send + Sync + 'static,
{ /* private fields */ }
Expand description

IO access point. This is passed to all IO handlers and provides an interface to the IO subsystem.

Implementations§

source§

impl<Message> IoContext<Message>
where Message: Send + Sync + 'static,

source

pub fn new(channel: IoChannel<Message>, handler: usize) -> IoContext<Message>

Create a new IO access point. Takes references to all the data that can be updated within the IO handler.

source

pub fn register_timer( &self, token: TimerToken, delay: Duration ) -> Result<(), IoError>

Register a new recurring IO timer. ‘IoHandler::timeout’ will be called with the token.

source

pub fn register_timer_once( &self, token: TimerToken, delay: Duration ) -> Result<(), IoError>

Register a new IO timer once. ‘IoHandler::timeout’ will be called with the token.

source

pub fn register_timer_once_nocancel( &self, token: TimerToken, delay: Duration ) -> Result<(), IoError>

Register a new IO timer once. ‘IoHandler::timeout’ will be called with the token. Do NOT cancel other timer on the same token after timeout.

source

pub fn clear_timer(&self, token: TimerToken) -> Result<(), IoError>

Delete a timer.

source

pub fn register_stream(&self, token: StreamToken) -> Result<(), IoError>

Register a new IO stream.

source

pub fn deregister_stream(&self, token: StreamToken) -> Result<(), IoError>

Deregister an IO stream.

source

pub fn update_registration(&self, token: StreamToken) -> Result<(), IoError>

Reregister an IO stream.

source

pub fn message(&self, message: Message) -> Result<(), IoError>

Broadcast a message to other IO clients

source

pub fn handle( &self, peer: usize, handler_id: usize, msg: Message ) -> Result<(), IoError>

source

pub fn channel(&self) -> IoChannel<Message>

Get message channel

source

pub fn unregister_handler(&self)

Unregister current IO handler.

Trait Implementations§

source§

impl<Message> Clone for IoContext<Message>
where Message: Send + Sync + 'static + Clone,

source§

fn clone(&self) -> IoContext<Message>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<Message> !RefUnwindSafe for IoContext<Message>

§

impl<Message> Send for IoContext<Message>

§

impl<Message> Sync for IoContext<Message>

§

impl<Message> Unpin for IoContext<Message>

§

impl<Message> !UnwindSafe for IoContext<Message>

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<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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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.
source§

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

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
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T