Struct Backup

pub struct Backup { /* private fields */ }

Stores Frames for reuse later.

Note

Empty Frames are an exception and are not stored within the backup nor are they tracked in terms of sent/received counts.

Implementations

impl Backup

pub fn new() -> Self

Creates a new, unfrozen backup.

pub fn clear(&mut self)

Clears the backup of any stored data and resets the state to being new.

Note

Like all other modifications, this will do nothing if the backup is frozen.

pub fn is_frozen(&self) -> bool

Returns true if the backup is frozen, meaning that modifications will be ignored.

pub fn set_frozen(&mut self, frozen: bool)

Sets the frozen status.

pub fn freeze(&mut self)

Marks the backup as frozen.

pub fn unfreeze(&mut self)

Marks the backup as no longer frozen.

pub fn set_max_backup_size(&mut self, size: usize)

Sets the maximum size (in bytes) of collective frames stored in case a backup is needed during reconnection. Setting the size to 0 will result in no frames being stored.

Note

Like all other modifications, this will do nothing if the backup is frozen.

pub fn max_backup_size(&self) -> usize

Returns the maximum size (in bytes) of collective frames stored in case a backup is needed during reconnection.

Trait Implementations

impl Clone for Backup

fn clone(&self) -> Backup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Backup

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

Formats the value using the given formatter.

impl Default for Backup

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Backup

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

impl StructuralPartialEq for Backup