Struct Framed

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

Implementations

impl<S> Framed<S>

pub fn peek(&self) -> &[u8]

impl<S> Framed<S>

where S: StreamWrapper,

pub fn new(stream: S::InnerStream) -> Self

pub fn new_with_leftover(stream: S::InnerStream, leftover: BytesMut) -> Self

pub fn into_inner(self) -> (S::InnerStream, BytesMut)

pub fn into_inner_no_leftover(self) -> S::InnerStream

pub fn get_inner(&self) -> (&S::InnerStream, &BytesMut)

pub fn get_inner_mut(&mut self) -> (&mut S::InnerStream, &mut BytesMut)

impl<S> Framed<S>

where S: FramedRead,

pub async fn read_exact(&mut self, length: usize) -> Result<BytesMut>

Accumulates at least length bytes and returns exactly length bytes, keeping the leftover in the internal buffer.

Cancel safety

This method is cancel safe. If you use it as the event in a tokio::select! statement and some other branch completes first, then it is safe to drop the future and re-create it later. Data may have been read, but it will be stored in the internal buffer.

pub async fn read_pdu(&mut self) -> Result<(Action, BytesMut)>

Reads a standard RDP PDU frame.

Cancel safety

This method is cancel safe. If you use it as the event in a tokio::select! statement and some other branch completes first, then it is safe to drop the future and re-create it later. Data may have been read, but it will be stored in the internal buffer.

pub async fn read_by_hint(&mut self, hint: &dyn PduHint) -> Result<Bytes>

Reads a frame using the provided PduHint.

Cancel safety

This method is cancel safe. If you use it as the event in a tokio::select! statement and some other branch completes first, then it is safe to drop the future and re-create it later. Data may have been read, but it will be stored in the internal buffer.

Trait Implementations

impl<S> FramedWrite for Framed<S>

where S: FramedWrite,

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> Self::WriteAllFut<'a>

Attempts to write an entire buffer into this Framed’s stream.

Cancel safety

This method is not cancellation safe. If it is used as the event in a tokio::select! statement and some other branch completes first, then the provided buffer may have been partially written, but future calls to write_all will start over from the beginning of the buffer.

type WriteAllFut<'write> = <S as FramedWrite>::WriteAllFut<'write> where Self: 'write