Struct HandshakeChannelHandler 

pub(crate) struct HandshakeChannelHandler {
    filter: MessageFilter,
    inner: ChannelCodec,
    send_log: Option<Sha256>,
    recv_log: Option<Sha256>,
}

The handshake channel handler which is used to decode and encode cells onto a channel that is handshaking with an endpoint.

Fields

filter: MessageFilter

Message filter used to allow or not a certain message.

inner: ChannelCodec

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

send_log: Option<Sha256>

The digest of bytes sent on this channel.

Will be used for the SLOG or CLOG of the AUTHENTICATE cell.

recv_log: Option<Sha256>

The digest of bytes received on this channel.

Will be used for the SLOG or CLOG of the AUTHENTICATE cell.

Implementations

impl HandshakeChannelHandler

fn new(new_handler: &mut NewChannelHandler, link_version: LinkVersion) -> Self

Constructor

fn finalize_log(log: Option<Sha256>) -> Option<[u8; 32]>

Internal helper: Take a SHA256 digest and finalize it if any. None is returned if no log digest is given.

fn next_handler(&mut self) -> OpenChannelHandler

Return an open handshake handler.

pub(crate) fn take_send_log_digest(&mut self) -> Option<[u8; 32]>

The digest of bytes sent on this channel.

This should only ever be called once as it consumes the send log.

This will return None if one of:

• The channel is not recording the send log.
• The send log digest has already been taken.

pub(crate) fn take_recv_log_digest(&mut self) -> Option<[u8; 32]>

The digest of bytes received on this channel.

This should only ever be called once as it consumes the receive log.

This will return None if one of:

• The channel is not recording the receive log.
• The receive log digest has already been taken.

pub(crate) fn channel_type(&self) -> ChannelType

Return the ChannelType of this handler.

pub(crate) fn set_authenticated(&mut self)

Mark this handler as authenticated.

Trait Implementations

impl Decoder for HandshakeChannelHandler

type Item = ChanCell<AnyChanMsg>

The type of items returned by decode

type Error = Error

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 Encoder for HandshakeChannelHandler

type Item<'a> = ChanCell<AnyChanMsg>

The type of items consumed by encode

type Error = Error

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.