Struct ntex::io::IoRef

pub struct IoRef(_);

Implementations

impl IoRef

pub fn memory_pool(&self) -> PoolRef

Get memory pool

pub fn is_closed(&self) -> bool

Check if io stream is closed

pub fn wake(&self)

Wake dispatcher task

pub fn close(&self)

Gracefully close connection

Notify dispatcher and initiate io stream shutdown process.

pub fn force_close(&self)

Force close connection

Dispatcher does not wait for uncompleted responses. Io stream get terminated without any graceful period.

pub fn want_shutdown(&self, err: Option<Error>)

Gracefully shutdown io stream

pub fn query<T>(&self) -> QueryItem<T> where
    T: 'static, 

Query filter specific data

pub fn encode<U>(
    &self,
    item: <U as Encoder>::Item,
    codec: &U
) -> Result<(), <U as Encoder>::Error> where
    U: Encoder, 

Encode and write item to a buffer and wake up write task

pub fn decode<U>(
    &self,
    codec: &U
) -> Result<Option<<U as Decoder>::Item>, <U as Decoder>::Error> where
    U: Decoder, 

Attempts to decode a frame from the read buffer

pub fn write(&self, src: &[u8]) -> Result<(), Error>

Write bytes to a buffer and wake up write task

pub fn with_write_buf<F, R>(&self, f: F) -> Result<R, Error> where
    F: FnOnce(&mut BytesMut) -> R, 

Get mut access to write buffer

pub fn with_read_buf<F, R>(&self, f: F) -> R where
    F: FnOnce(&mut BytesMut) -> R, 

Get mut access to read buffer

pub fn on_disconnect(&self) -> OnDisconnect

Notify when io stream get disconnected

Trait Implementations

impl<F> AsRef<IoRef> for Io<F>

pub fn as_ref(&self) -> &IoRef

Performs the conversion.

impl Clone for IoRef

pub fn clone(&self) -> IoRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IoRef

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.