Struct RecvStep

pub struct RecvStep<'b, P: ReadPrecision> {
    buffer: &'b mut Buffer<P>,
    deficit: NonZeroUsize,
}

Available on crate features proxy-handshake or client-handshake only.

Next step - details for reading from the peer

Value in NextStep::Recv.

Caller should read from the peer and call one of the received functions. Specifically, caller should do one of the following:

1. Read some data into the slice returned by .buf(), and then call .note_received().

2. Determine the available buffer space with .buf().len(), write some data into the buffer’s unfilled_slice(), and call Buffer::note_received. This allows the caller to dispose of the RecvStep (which mutably borrows the Buffer) while reading, at the cost of slightly less correctness checking by the compiler.

The caller should not wait for enough data to fill the whole buf.

Fields

buffer: &'b mut Buffer<P>

The buffer

deficit: NonZeroUsize

Lower bound on the number of bytes that the handshake needs to read to complete.

Useful only for callers that want to avoid reading beyond the end of the handshake. Always <= .buf().len().

The returned value has the same semantics as [tor_bytes::IncompleteMessage.deficit.

Implementations

impl<'b, P: ReadPrecision> RecvStep<'b, P>

pub fn buf(&mut self) -> &mut [u8]

Returns the buffer slice the caller should write data into.

For precise reads, returns the slice of the buffer of length deficit. sol as to avoid reading ahead beyond the end of the handshake.

pub fn note_received(self, len: usize) -> Result<(), Error>

Notes that len bytes have been received.

The actual data must already have been written to the slice from .buf().

If len == 0, treats this as having received EOF (which is an error).

Panics

len must be no more than .buf().len().

Trait Implementations

impl<'b, P: Debug + ReadPrecision> Debug for RecvStep<'b, P>

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

Formats the value using the given formatter.