Struct ChannelCodec

pub(crate) struct ChannelCodec<IN, OUT> {
    inner: ChannelCodec,
    _phantom_in: PhantomData<fn(IN)>,
    _phantom_out: PhantomData<fn() -> OUT>,
}

Asynchronous wrapper around ChannelCodec in tor_cell, with implementation for use with asynchronous_codec.

This type lets us wrap a TLS channel (or some other secure AsyncRead+AsyncWrite type) as a Sink and a Stream of ChanCell, so we can forget about byte-oriented communication.

It’s parameterized on two message types: one that we’re allowed to receive (IN), and one that we’re allowed to send (OUT).

Fields

inner: ChannelCodec

The cell codec that we’ll use to encode and decode our cells.

_phantom_in: PhantomData<fn(IN)>

Tells the compiler that we’re using IN, and we might consume values of type IN.

_phantom_out: PhantomData<fn() -> OUT>

Tells the compiler that we’re using OUT, and we might produce values of type OUT.

Implementations

impl<IN, OUT> ChannelCodec<IN, OUT>

pub(crate) fn new(link_proto: u16) -> Self

Create a new ChannelCodec with a given link protocol.

pub(crate) fn change_message_types<IN2, OUT2>(self) -> ChannelCodec<IN2, OUT2>

Consume this codec, and return a new one that sends and receives different message types.

Trait Implementations

impl<IN, OUT> Decoder for ChannelCodec<IN, OUT>

where IN: ChanMsg,

type Item = ChanCell<IN>

The type of items returned by decode

type Error = CodecError

The type of decoding errors.

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Decode an item from the src BytesMut into an item

fn decode_eof( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Called when the input stream reaches EOF, signaling a last attempt to decode

impl<IN, OUT> Encoder for ChannelCodec<IN, OUT>

where OUT: ChanMsg,

type Item<'a> = ChanCell<OUT>

The type of items consumed by encode

type Error = CodecError

The type of encoding errors.

fn encode( &mut self, item: Self::Item<'_>, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes an item into the BytesMut provided by dst.