Struct ClientHandshake

pub struct ClientHandshake<'a> { /* private fields */ }

The ClientHandshake struct represents a client handshake message.

Available fields:

• mtype: Identifies the message as client handshake. (value = 'V')

• mlen: Length of message contents in bytes, including self.

• major_ver: Requested protocol major version.

• minor_ver: Requested protocol minor version.

• params: Connection parameters.

• extensions: Requested protocol extensions.

Implementations

impl<'a> ClientHandshake<'a>

pub const fn is_buffer(buf: &'a [u8]) -> bool

Checks the constant values for this struct to determine whether this message matches.

pub fn new(buf: &'a [u8]) -> Result<Self, ParseError>

Creates a new instance of this struct from a given buffer.

pub fn mtype(&self) -> u8

Identifies the message as client handshake.

pub fn mlen(&self) -> Length

Length of message contents in bytes, including self.

pub fn major_ver(&self) -> u16

Requested protocol major version.

pub fn minor_ver(&self) -> u16

Requested protocol minor version.

pub fn params(&self) -> Array<'a, i16, ConnectionParam<'a>>

Connection parameters.

pub fn extensions(&self) -> Array<'a, i16, ProtocolExtension<'a>>

Requested protocol extensions.

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

Trait Implementations

impl AsRef<[u8]> for ClientHandshake<'_>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for ClientHandshake<'a>

fn clone(&self) -> ClientHandshake<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> DataType for ClientHandshake<'a>

const META: StructFieldMeta

fn encode_usize(buf: &mut BufWriter<'_>, value: usize)

fn decode_usize(buf: &mut &[u8]) -> Result<usize, ParseError>

impl Debug for ClientHandshake<'_>

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

Formats the value using the given formatter.

impl<'a> DecoderFor<'a, ClientHandshake<'a>> for ClientHandshake<'a>

fn decode_for(buf: &mut &'a [u8]) -> Result<Self, ParseError>

impl<'a> Default for ClientHandshake<'a>

fn default() -> ClientHandshake<'a>

Returns the “default value” for a type.

impl<MAJOR_VER, MINOR_VER, PARAMS, EXTENSIONS> EncoderFor<ClientHandshake<'static>> for &ClientHandshakeBuilder<MAJOR_VER, MINOR_VER, PARAMS, EXTENSIONS>

where MAJOR_VER: EncoderFor<u16>, MINOR_VER: EncoderFor<u16>, PARAMS: EncoderFor<Array<'static, i16, ConnectionParam<'static>>>, EXTENSIONS: EncoderFor<Array<'static, i16, ProtocolExtension<'static>>>,

fn encode_for(&self, buf: &mut BufWriter<'_>)

impl<'a> EncoderFor<ClientHandshake<'static>> for ClientHandshake<'a>

fn encode_for(&self, buf: &mut BufWriter<'_>)

impl<MAJOR_VER, MINOR_VER, PARAMS, EXTENSIONS> EncoderFor<ClientHandshake<'static>> for ClientHandshakeBuilder<MAJOR_VER, MINOR_VER, PARAMS, EXTENSIONS>

where MAJOR_VER: EncoderFor<u16>, MINOR_VER: EncoderFor<u16>, PARAMS: EncoderFor<Array<'static, i16, ConnectionParam<'static>>>, EXTENSIONS: EncoderFor<Array<'static, i16, ProtocolExtension<'static>>>,

fn encode_for(&self, buf: &mut BufWriter<'_>)

impl PartialEq for ClientHandshake<'_>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructMeta for ClientHandshake<'a>

Implements a trait containing the fields of the struct, allowing us to compute some useful things.

const FIELDS: StructFields

type Struct<'__struct> = ClientHandshake<'__struct>

fn new<'__next_lifetime>( buf: &'__next_lifetime [u8], ) -> Result<Self::Struct<'__next_lifetime>, ParseError>

fn to_vec(&self) -> Vec<u8>

const FIELD_COUNT: usize = _

const IS_FIXED_SIZE: bool = _

const FIXED_SIZE: Option<usize> = _

const LENGTH_FIELD_INDEX: Option<usize> = _

const HAS_LENGTH_FIELD: bool = _

impl<'a> Copy for ClientHandshake<'a>

impl Eq for ClientHandshake<'_>

impl StructAttributeFieldCount<{<$name<'_> as $crate::prelude::StructMeta>::FIELD_COUNT}> for ClientHandshake<'_>

Implements a trait indicating that the struct has a field count.

impl StructAttributeFixedSize<{<$name<'_> as $crate::prelude::StructMeta>::IS_FIXED_SIZE}> for ClientHandshake<'_>

Implements a trait indicating that the struct has a fixed size. This needs to be a trait-generic rather than and associated constant for us to use elsewhere.

impl StructAttributeHasLengthField<{<$name<'_> as $crate::prelude::StructMeta>::HAS_LENGTH_FIELD}> for ClientHandshake<'_>

Implements a trait indicating that the struct has a length field.