Struct CommitOutput

pub struct CommitOutput {
    pub commit_message: Arc<Message>,
    pub welcome_message: Option<Arc<Message>>,
    pub ratchet_tree: Option<RatchetTree>,
    pub group_info: Option<Arc<Message>>,
}

Fields

commit_message: Arc<Message>

Commit message to send to other group members.

welcome_message: Option<Arc<Message>>

Welcome message to send to new group members. This will be None if the commit did not add new members.

ratchet_tree: Option<RatchetTree>

Ratchet tree that can be sent out of band if the ratchet tree extension is not used.

group_info: Option<Arc<Message>>

A group info that can be provided to new members in order to enable external commit functionality.

Trait Implementations

impl Clone for CommitOutput

fn clone(&self) -> CommitOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for CommitOutput

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for CommitOutput

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

Formats the value using the given formatter.

impl<T> FfiConverter<T> for CommitOutput

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for CommitOutput

const TYPE_ID_META: MetadataBuffer

type FfiType = <CommitOutput as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for CommitOutput

type LiftType = CommitOutput

impl<UT> LiftReturn<UT> for CommitOutput

const TYPE_ID_META: MetadataBuffer

fn lift_callback_return(buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method result

fn lift_callback_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for CommitOutput

const TYPE_ID_META: MetadataBuffer

type FfiType = <CommitOutput as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerReturn<UT> for CommitOutput

const TYPE_ID_META: MetadataBuffer

type ReturnType = <CommitOutput as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustBuffer>

Lower this value for scaffolding function return

fn handle_failed_lift(arg_name: &str, e: Error) -> Self

If possible, get a serialized error for failed argument lifts

impl TryFrom<CommitOutput> for CommitOutput

type Error = Error

The type returned in the event of a conversion error.

fn try_from(commit_output: CommitOutput) -> Result<Self, Error>

Performs the conversion.