Struct CommitOptions

#[non_exhaustive]
pub struct CommitOptions {
    pub path_required: bool,
    pub ratchet_tree_extension: bool,
    pub single_welcome_message: bool,
    pub allow_external_commit: bool,
    pub always_out_of_band_ratchet_tree: bool,
}

Options controlling commit generation

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path_required: bool

ratchet_tree_extension: bool

single_welcome_message: bool

allow_external_commit: bool

always_out_of_band_ratchet_tree: bool

Include the ratchet tree out of band and not in the external group info, regardless of the presence of the ratchet tree extension (doesn’t affect commits/welcome).

Implementations

impl CommitOptions

pub fn new() -> Self

pub fn with_path_required(self, path_required: bool) -> Self

pub fn with_ratchet_tree_extension(self, ratchet_tree_extension: bool) -> Self

pub fn with_single_welcome_message(self, single_welcome_message: bool) -> Self

pub fn with_allow_external_commit(self, allow_external_commit: bool) -> Self

pub fn with_always_out_of_band_ratchet_tree( self, always_out_of_band_ratchet_tree: bool, ) -> Self

Trait Implementations

impl Clone for CommitOptions

fn clone(&self) -> CommitOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommitOptions

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

Formats the value using the given formatter.

impl Default for CommitOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CommitOptions

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

impl Eq for CommitOptions

impl StructuralPartialEq for CommitOptions