Struct Extensions 

pub struct Extensions<T> { /* private fields */ }

Available on 32-bit or 64-bit only.

A Extension for Object of type T

Implementations

impl<T: ExtensionValidator> Extensions<T>

pub fn empty() -> Self

Create an empty extension list.

pub fn iter(&self) -> impl Iterator<Item = &Extension>

Returns an iterator over the extension list.

pub fn remove(&mut self, extension_type: ExtensionType) -> Option<Extension>

Remove an extension from the extension list.

Returns the removed extension or None when there is no extension with the given extension type.

pub fn contains(&self, extension_type: ExtensionType) -> bool

Returns true iff the extension list contains an extension with the given extension type.

impl<T> Extensions<T>

where T: ExtensionValidator, InvalidExtensionError: From<T::Error>,

pub fn single(extension: Extension) -> Result<Self, InvalidExtensionError>

Create an extension list with a single extension.

pub fn from_vec( extensions: Vec<Extension>, ) -> Result<Self, InvalidExtensionError>

Create an extension list with multiple extensions.

This function will fail when the list of extensions contains duplicate extension types.

pub fn validate<'a>( extensions: impl Iterator<Item = &'a Extension>, ) -> Result<(), InvalidExtensionError>

Validate if the extensions are valid for this context

pub fn add(&mut self, extension: Extension) -> Result<(), InvalidExtensionError>

Add an extension to the extension list.

Returns an error when there already is an extension with the same extension type.

pub fn add_or_replace( &mut self, extension: Extension, ) -> Result<Option<Extension>, InvalidExtensionError>

Add an extension to the extension list (or replace an existing one.)

Returns the replaced extension (if any).

impl<T> Extensions<T>

pub fn application_id(&self) -> Option<&ApplicationIdExtension>

Get a reference to the ApplicationIdExtension if there is any.

pub fn ratchet_tree(&self) -> Option<&RatchetTreeExtension>

Get a reference to the RatchetTreeExtension if there is any.

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

Get a reference to the RequiredCapabilitiesExtension if there is any.

pub fn external_pub(&self) -> Option<&ExternalPubExtension>

Get a reference to the ExternalPubExtension if there is any.

pub fn external_senders(&self) -> Option<&ExternalSendersExtension>

Get a reference to the ExternalSendersExtension if there is any.

pub fn app_data_dictionary(&self) -> Option<&AppDataDictionaryExtension>

Available on crate feature extensions-draft-08 only.

Get a reference to the AppDataDictionaryExtension if there is any.

pub fn unknown(&self, extension_type_id: u16) -> Option<&UnknownExtension>

Get a reference to the UnknownExtension with the given type id, if there is any.

Trait Implementations

impl<T: Clone> Clone for Extensions<T>

fn clone(&self) -> Extensions<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Extensions<T>

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

Formats the value using the given formatter.

impl<T> Default for Extensions<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Extensions<T>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: ExtensionValidator> Deserialize for Extensions<T>

where InvalidExtensionError: From<T::Error>,

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

where Self: Sized,

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<T: ExtensionValidator> DeserializeBytes for Extensions<T>

where InvalidExtensionError: From<T::Error>,

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

where Self: Sized,

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 From<Extensions<GroupContext>> for Extensions<AnyObject>

fn from(value: Extensions<GroupContext>) -> Self

Converts to this type from the input type.

impl From<Extensions<KeyPackage>> for Extensions<AnyObject>

fn from(value: Extensions<KeyPackage>) -> Self

Converts to this type from the input type.

impl From<Extensions<LeafNode>> for Extensions<AnyObject>

fn from(value: Extensions<LeafNode>) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for Extensions<T>

fn eq(&self, other: &Extensions<T>) -> 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<T> Serialize for Extensions<T>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Serialize for Extensions<T>

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<T> Size for Extensions<T>

fn tls_serialized_len(&self) -> usize

impl TryFrom<Extensions<AnyObject>> for Extensions<GroupContext>

type Error = ExtensionTypeNotValidInGroupContextError

The type returned in the event of a conversion error.

fn try_from( value: Extensions<AnyObject>, ) -> Result<Self, ExtensionTypeNotValidInGroupContextError>

Performs the conversion.

impl TryFrom<Extensions<AnyObject>> for Extensions<KeyPackage>

type Error = ExtensionTypeNotValidInKeyPackageError

The type returned in the event of a conversion error.

fn try_from( value: Extensions<AnyObject>, ) -> Result<Self, ExtensionTypeNotValidInKeyPackageError>

Performs the conversion.

impl TryFrom<Extensions<AnyObject>> for Extensions<LeafNode>

type Error = ExtensionTypeNotValidInLeafNodeError

The type returned in the event of a conversion error.

fn try_from( value: Extensions<AnyObject>, ) -> Result<Self, ExtensionTypeNotValidInLeafNodeError>

Performs the conversion.

impl<T: ExtensionValidator> TryFrom<Vec<Extension>> for Extensions<T>

where InvalidExtensionError: From<T::Error>,

type Error = InvalidExtensionError

The type returned in the event of a conversion error.

fn try_from(candidate: Vec<Extension>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Eq> Eq for Extensions<T>

impl<T> StructuralPartialEq for Extensions<T>