Struct rustls::internal::msgs::message::OpaqueMessage

source ·
pub struct OpaqueMessage {
    pub typ: ContentType,
    pub version: ProtocolVersion,
    /* private fields */
}
Expand description

A TLS frame, named TLSPlaintext in the standard.

This type owns all memory for its interior parts. It is used to read/write from/to I/O buffers as well as for fragmenting, joining and encryption/decryption. It can be converted into a Message by decoding the payload.

§Decryption

Internally the message payload is stored as a Vec<u8>; this can by mutably borrowed with OpaqueMessage::payload_mut(). This is useful for decrypting a message in-place. After the message is decrypted, call OpaqueMessage::into_plain_message() or OpaqueMessage::into_tls13_unpadded_message() (depending on the protocol version).

Fields§

§typ: ContentType§version: ProtocolVersion

Implementations§

source§

impl OpaqueMessage

source

pub fn new(typ: ContentType, version: ProtocolVersion, body: Vec<u8>) -> Self

Construct a new OpaqueMessage from constituent fields.

body is moved into the payload field.

source

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

Access the message payload as a slice.

source

pub fn payload_mut(&mut self) -> &mut Vec<u8>

Access the message payload as a mutable Vec<u8>.

source

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

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

source

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

source

pub fn into_plain_message(self) -> PlainMessage

Force conversion into a plaintext message.

This should only be used for messages that are known to be in plaintext. Otherwise, the OpaqueMessage should be decrypted into a PlainMessage using a MessageDecrypter.

source

pub fn into_tls13_unpadded_message(self) -> Result<PlainMessage, 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.

source

pub const MAX_WIRE_SIZE: usize = 18_437usize

Maximum on-wire message size.

Trait Implementations§

source§

impl Clone for OpaqueMessage

source§

fn clone(&self) -> OpaqueMessage

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for OpaqueMessage

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.