Struct WriteBuf

Source
pub struct WriteBuf<S> {
    pub out_buf: Buf,
    /* private fields */
}
Expand description

An output counterpart of IoBuf when the latter is split

Fields§

§out_buf: Buf

Implementations§

Source§

impl<S> WriteBuf<S>

Source

pub fn flush(&mut self) -> Result<(), Error>
where S: AsyncWrite,

Write data in the output buffer to actual stream

You should put the data to be sent into self.out_buf before flush

Note: this method silently assumes that you will call it on poll every time until self.done() returns false. I.e. it behaves as Async method but does’t return Async value to allow simpler handling

Source

pub fn done(&self) -> bool

Returns true when connection is closed by peer

Note: this method returns false and schedules a wakeup if connecion is currently locked

Source

pub fn borrow_raw(self) -> FutureWriteRaw<S>

Returns a future which will resolve into WriteRaw

This future resolves when after two conditions:

  1. Output buffer is fully flushed to the network (i.e. OS buffers)
  2. Internal BiLock is locked

Note: WriteRaw will lock the underlying stream for the whole lifetime of the WriteRaw.

Source

pub fn framed<E: Encode>(self, codec: E) -> WriteFramed<S, E>

Trait Implementations§

Source§

impl<S> Debug for WriteBuf<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> Freeze for WriteBuf<S>

§

impl<S> !RefUnwindSafe for WriteBuf<S>

§

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

§

impl<S> Sync for WriteBuf<S>
where S: Send,

§

impl<S> Unpin for WriteBuf<S>

§

impl<S> !UnwindSafe for WriteBuf<S>

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

Source§

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>,

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.