Struct SenderRatchetConfiguration

pub struct SenderRatchetConfiguration { /* private fields */ }

Stores the configuration parameters for DecryptionRatchets.

Parameters

• out_of_order_tolerance: This parameter defines a window for which decryption secrets are kept. This is useful in case the DS cannot guarantee that all application messages have total order within an epoch. Use this carefully, since keeping decryption secrets affects forward secrecy within an epoch. The default value is 5.
• maximum_forward_distance: This parameter defines how many incoming messages can be skipped. This is useful if the DS drops application messages. The default value is 1000.

Implementations

impl SenderRatchetConfiguration

pub fn new(out_of_order_tolerance: u32, maximum_forward_distance: u32) -> Self

Create a new configuration

pub fn out_of_order_tolerance(&self) -> u32

Get a reference to the sender ratchet configuration’s out of order tolerance.

pub fn maximum_forward_distance(&self) -> u32

Get a reference to the sender ratchet configuration’s maximum forward distance.

Trait Implementations

impl Clone for SenderRatchetConfiguration

fn clone(&self) -> SenderRatchetConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SenderRatchetConfiguration

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

Formats the value using the given formatter.

impl Default for SenderRatchetConfiguration

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SenderRatchetConfiguration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SenderRatchetConfiguration

fn eq(&self, other: &SenderRatchetConfiguration) -> 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 SenderRatchetConfiguration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SenderRatchetConfiguration

impl StructuralPartialEq for SenderRatchetConfiguration