Struct SimulcryptMessage 

pub struct SimulcryptMessage<'a> {
    pub protocol_version: u8,
    pub message_type: MessageType,
    pub parameters: Vec<Parameter<'a>>,
}

A generic SimulCrypt message (TS 103 197 Table 1b): the 5-byte header plus an ordered list of TLV Parameters.

The Interface is not on the wire — it is fixed by the TCP connection the message arrived on, and is supplied to SimulcryptMessage::parse_on so the raw message_type/parameter_type values can be decoded into the right interface-scoped registry.

Fields

protocol_version: u8

protocol_version (Table 2; 0x03 for both implemented interfaces).

message_type: MessageType

The interface-tagged message_type.

parameters: Vec<Parameter<'a>>

The TLV parameter list, in wire order (order is not significant per NOTE 2, but is preserved for byte-exact round-tripping).

Implementations

impl<'a> SimulcryptMessage<'a>

pub fn new( protocol_version: u8, message_type: MessageType, parameters: Vec<Parameter<'a>>, ) -> Self

Construct a message from typed fields.

pub const fn interface(&self) -> Interface

The interface this message was decoded against (from its message_type).

pub fn body_len(&self) -> usize

Sum of the wire lengths of every parameter TLV — i.e. the value the message_length field will carry on serialize.

pub fn find(&self, ptype: ParameterType) -> Option<&Parameter<'a>>

Find the first parameter whose parameter_type matches ptype.

pub fn parse_on(iface: Interface, bytes: &'a [u8]) -> Result<Self>

Parse a message off the wire, decoding message_type/parameter_type against the given Interface (the connection’s interface).

Errors

Returns Error::BufferTooShort if the header or a TLV header is truncated, Error::InvalidMessageLength if message_length overruns the buffer, and Error::TruncatedParameter if a parameter_length runs past the message body.

Trait Implementations

impl<'a> Clone for SimulcryptMessage<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SimulcryptMessage<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for SimulcryptMessage<'a>

impl<'a> Parse<'a> for SimulcryptMessage<'a>

fn parse(bytes: &'a [u8]) -> Result<Self>

Parse against the ECMG⇔SCS interface by default. Most callers should use SimulcryptMessage::parse_on with the connection’s interface; this Parse impl exists to satisfy the workspace-wide trait contract.

type Error = Error

The error type this implementer returns. Typically the enclosing crate’s Error enum.

impl<'a> PartialEq for SimulcryptMessage<'a>

fn eq(&self, other: &SimulcryptMessage<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> Serialize for SimulcryptMessage<'a>

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Serialize for SimulcryptMessage<'_>

type Error = Error

The error type this implementer returns (usually the same as the corresponding Parse impl, but need not be).

fn serialized_len(&self) -> usize

Number of bytes serialize_into will write.

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

Write the serialised form into buf. Returns the number of bytes written (always equal to serialized_len()).

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

where Self::Error: Debug,

Convenience: allocate a Vec and serialise into it.

impl<'a> StructuralPartialEq for SimulcryptMessage<'a>