Struct EncodedMessage 

pub struct EncodedMessage<P> {
    pub typ: ContentType,
    pub version: ProtocolVersion,
    pub payload: P,
}

A TLS message with encoded (but not necessarily encrypted) payload.

Fields

typ: ContentType

The content type of this message.

version: ProtocolVersion

The protocol version of this message.

payload: P

The payload of this message.

Implementations

impl<P> EncodedMessage<P>

pub fn new(typ: ContentType, version: ProtocolVersion, payload: P) -> Self

Create a new EncodedMessage with the given fields.

impl<'a> EncodedMessage<Payload<'a>>

pub fn read(r: &mut Reader<'a>) -> Result<Self, MessageError>

Construct by decoding from a [Reader].

MessageError allows callers to distinguish between valid prefixes (might become valid if we read more data) and invalid data.

pub fn into_unencrypted_opaque(self) -> EncodedMessage<OutboundOpaque>

Convert into an unencrypted EncodedMessage<OutboundOpaque> (without decrypting).

pub fn borrow_outbound(&'a self) -> EncodedMessage<OutboundPlain<'a>>

Borrow as an EncodedMessage<OutboundPlain<'a>>.

pub fn into_owned(self) -> Self

Convert into an owned EncodedMessage<Plain<'static>>.

impl<'a> EncodedMessage<InboundOpaque<'a>>

pub fn into_tls13_unpadded_message( self, ) -> Result<EncodedMessage<&'a [u8]>, Error>

For TLS1.3 (only), checks the length msg.payload is valid and removes the padding.

Returns an error if the message (pre-unpadding) is too long, or the padding is invalid, or the message (post-unpadding) is too long.

pub fn into_plain_message_range( self, range: Range<usize>, ) -> EncodedMessage<&'a [u8]>

Force conversion into a plaintext message.

range restricts the resulting message: this function panics if it is out of range for the underlying message payload.

This should only be used for messages that are known to be in plaintext. Otherwise, the EncodedMessage<InboundOpaque<'_>> should be decrypted into an EncodedMessage<&'_ [u8]> using a MessageDecrypter.

pub fn into_plain_message(self) -> EncodedMessage<&'a [u8]>

Force conversion into a plaintext message.

This should only be used for messages that are known to be in plaintext. Otherwise, the EncodedMessage<InboundOpaque<'a>> should be decrypted into a EncodedMessage<&'a [u8]> using a MessageDecrypter.

impl EncodedMessage<OutboundOpaque>

pub fn encode(self) -> Vec<u8>

Encode this message to a vector of bytes.

Trait Implementations

impl<P: Clone> Clone for EncodedMessage<P>

fn clone(&self) -> EncodedMessage<P>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P: Debug> Debug for EncodedMessage<P>

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

Formats the value using the given formatter.