Struct GroupContext 

pub struct GroupContext { /* private fields */ }

Available on 32-bit or 64-bit only.

8.1 Group Context

 struct {
     ProtocolVersion version = mls10;
     CipherSuite cipher_suite;
     opaque group_id<V>;
     uint64 epoch;
     opaque tree_hash<V>;
     opaque confirmed_transcript_hash<V>;
     Extension extensions<V>;
 } GroupContext;

 The [`GroupContext`] is a state object maintained which summarizes the group
 state agreed upon by each member of the group.

Implementations

impl GroupContext

pub fn safe_aad_required(&self) -> bool

Available on crate feature extensions-draft-08 only.

Whether Safe AAD framing is active for messages in this group.

Returns true exactly when the app_data_dictionary GroupContext extension contains a safe_aad component (the value bytes are not inspected here, an empty ComponentsList is still “present”). Per the Safe AAD spec section 4.9, when this is true the authenticated_data field always starts with the SafeAAD struct.

pub fn safe_aad_required_components( &self, ) -> Result<Option<Vec<ComponentId>>, SafeAadError>

Available on crate feature extensions-draft-08 only.

The list of ComponentIds required to be understood by every member for Safe AAD purposes.

Returns Ok(None) when the safe_aad component is absent from the app_data_dictionary GroupContext extension, Ok(Some(list)) when it is present and parses cleanly (the list may be empty), and an error when the component value fails to decode as a ComponentsList.

pub fn protocol_version(&self) -> ProtocolVersion

Return the protocol version.

pub fn ciphersuite(&self) -> Ciphersuite

Return the ciphersuite.

pub fn group_id(&self) -> &GroupId

Return the group ID.

pub fn epoch(&self) -> GroupEpoch

Return the epoch.

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

Return the tree hash.

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

Return the confirmed transcript hash.

pub fn extensions(&self) -> &Extensions<GroupContext>

Return the extensions.

pub fn required_capabilities(&self) -> Option<&RequiredCapabilitiesExtension>

Get the required capabilities extension.

Trait Implementations

impl Clone for GroupContext

fn clone(&self) -> GroupContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GroupContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Deserialize for GroupContext

fn tls_deserialize<R: Read>(bytes: &mut R) -> Result<Self, Error>

Available on crate feature std only.

This function deserializes the bytes from the provided a std::io::Read and returns the populated struct.

fn tls_deserialize_exact(bytes: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Available on crate feature std only.

This function deserializes the provided bytes and returns the populated struct. All bytes must be consumed.

impl DeserializeBytes for GroupContext

fn tls_deserialize_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

This function deserializes the bytes from the provided a &[u8] and returns the populated struct, as well as the remaining slice.

fn tls_deserialize_exact_bytes(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

This function deserializes the provided bytes and returns the populated struct. All bytes must be consumed.

impl ExtensionValidator for GroupContext

type Error = ExtensionTypeNotValidInGroupContextError

The error returned by the validator

fn validate_extension_type( ext: &Extension, ) -> Result<(), ExtensionTypeNotValidInGroupContextError>

Check if the extension is valid.

impl PartialEq for GroupContext

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

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

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 Serialize for &GroupContext

fn tls_serialize<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Available on crate feature std only.

Serialize self and write it to the writer. The function returns the number of bytes written to writer.

fn tls_serialize_detached(&self) -> Result<Vec<u8>, Error>

Available on crate feature std only.

Serialize self and return it as a byte vector.

impl Serialize for GroupContext

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 GroupContext

fn tls_serialize<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Available on crate feature std only.

Serialize self and write it to the writer. The function returns the number of bytes written to writer.

fn tls_serialize_detached(&self) -> Result<Vec<u8>, Error>

Available on crate feature std only.

Serialize self and return it as a byte vector.

impl Size for &GroupContext

fn tls_serialized_len(&self) -> usize

impl Size for GroupContext

fn tls_serialized_len(&self) -> usize

impl Entity<CURRENT_VERSION> for GroupContext

impl Eq for GroupContext

impl GroupContext<CURRENT_VERSION> for GroupContext

impl StructuralPartialEq for GroupContext