Struct ntex_io::IoRef

source · [−]

pub struct IoRef(_);

Implementations

source

impl IoRef

source

pub fn memory_pool(&self) -> PoolRef

Get memory pool

source

pub fn is_closed(&self) -> bool

Check if io stream is closed

source

pub fn wake(&self)

Wake dispatcher task

source

pub fn close(&self)

Gracefully close connection

Notify dispatcher and initiate io stream shutdown process.

source

pub fn force_close(&self)

Force close connection

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

source

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

Gracefully shutdown io stream

source

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

Query filter specific data

source

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

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

source

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

Attempts to decode a frame from the read buffer

source

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

Write bytes to a buffer and wake up write task

source

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

Get mut access to write buffer

source

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

Get mut access to read buffer

source

pub fn on_disconnect(&self) -> OnDisconnectⓘNotable traits for OnDisconnect`impl Future for OnDisconnect type Output = ();`

Notify when io stream get disconnected

Trait Implementations

source

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

source

fn as_ref(&self) -> &IoRef

Performs the conversion.

source

impl Clone for IoRef

source

fn clone(&self) -> IoRef

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

source

impl Debug for IoRef

source

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

Formats the value using the given formatter. Read more

source

impl Hash for IoRef

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<IoRef> for IoRef

source

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

source

impl Eq for IoRef

Auto Trait Implementations

impl !RefUnwindSafe for IoRef

impl !Send for IoRef

impl !Sync for IoRef

impl Unpin for IoRef

impl !UnwindSafe for IoRef

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ntex_io::IoRef

Implementations

impl IoRef

pub fn memory_pool(&self) -> PoolRef

pub fn is_closed(&self) -> bool

pub fn wake(&self)

pub fn close(&self)

pub fn force_close(&self)

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

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

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

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

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

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

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

pub fn on_disconnect(&self) -> OnDisconnectⓘNotable traits for OnDisconnectimpl Future for OnDisconnect type Output = ();

Trait Implementations

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

fn as_ref(&self) -> &IoRef

impl Clone for IoRef

fn clone(&self) -> IoRef

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

impl Debug for IoRef

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

impl Hash for IoRef

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl PartialEq<IoRef> for IoRef

fn eq(&self, other: &Self) -> bool

fn ne(&self, other: &Rhs) -> bool

impl Eq for IoRef

Auto Trait Implementations

impl !RefUnwindSafe for IoRef

impl !Send for IoRef

impl !Sync for IoRef

impl Unpin for IoRef

impl !UnwindSafe for IoRef

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

pub fn on_disconnect(&self) -> OnDisconnectⓘNotable traits for OnDisconnect`impl Future for OnDisconnect type Output = ();`

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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