LibraryError

xmtp_cryptography::openmls::prelude

Struct LibraryError

pub struct LibraryError { /* private fields */ }

Expand description

Generic error type that indicates unrecoverable errors in the library.

This error has 3 subtypes:

MissingBoundsCheck

This error is returned when the library tries to serialize data that is too big for the MLS structs. In particular, when element lists contain more elements than the theoretical maximum defined in the spec, the serialization will fail. This should not happen when all input values are checked.

CryptoError

This error is returned if the underlying crypto provider encountered an unexpected error. Possible reasons for this could be: the implementation of the crypto provider is not correct, the key material is not correct, the crypto provider does not support all functions required. Another reason could be that the OpenMLS library does not use the crypto provider API correctly.

Custom

This error is returned in situations where the implementation would otherwise use an unwrap(). If applications receive this error, it clearly indicates an implementation mistake in OpenMLS. The error includes a string that can give some more context about where the error originated and helps debugging.

In all cases, when a LibraryError is returned, applications should try to recover gracefully from it. It is recommended to log the error for potential debugging.

Trait Implementations§

impl Clone for LibraryError

fn clone(&self) -> LibraryError

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for LibraryError

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

Formats the value using the given formatter. Read more

impl Display for LibraryError

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

Formats the value using the given formatter. Read more

impl Error for LibraryError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more

1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports. Read more

impl<StorageError> From<LibraryError> for AddMembersError<StorageError>

fn from(source: LibraryError) -> AddMembersError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for ApplyUpdatePathError

fn from(source: LibraryError) -> ApplyUpdatePathError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for CommitBuilderStageError<StorageError>

fn from(source: LibraryError) -> CommitBuilderStageError<StorageError>

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for CommitToPendingProposalsError<StorageError>

fn from(source: LibraryError) -> CommitToPendingProposalsError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for CreateAddProposalError

fn from(source: LibraryError) -> CreateAddProposalError

Converts to this type from the input type.

impl From<LibraryError> for CreateCommitError

fn from(source: LibraryError) -> CreateCommitError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for CreateGroupContextExtProposalError<StorageError>

fn from( source: LibraryError, ) -> CreateGroupContextExtProposalError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for CreateMessageError

fn from(source: LibraryError) -> CreateMessageError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for CreationFromExternalError<StorageError>

fn from(source: LibraryError) -> CreationFromExternalError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for CredentialError

fn from(source: LibraryError) -> CredentialError

Converts to this type from the input type.

impl From<LibraryError> for ExportGroupInfoError

fn from(source: LibraryError) -> ExportGroupInfoError

Converts to this type from the input type.

impl From<LibraryError> for ExportSecretError

fn from(source: LibraryError) -> ExportSecretError

Converts to this type from the input type.

impl From<LibraryError> for ExtensionError

fn from(source: LibraryError) -> ExtensionError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for ExternalCommitBuilderError<StorageError>

fn from(source: LibraryError) -> ExternalCommitBuilderError<StorageError>

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for ExternalCommitBuilderFinalizeError<StorageError>

fn from( source: LibraryError, ) -> ExternalCommitBuilderFinalizeError<StorageError>

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for ExternalCommitError<StorageError>

fn from(source: LibraryError) -> ExternalCommitError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for ExternalCommitValidationError

fn from(source: LibraryError) -> ExternalCommitValidationError

Converts to this type from the input type.

impl From<LibraryError> for GroupContextExtensionsProposalValidationError

fn from(source: LibraryError) -> GroupContextExtensionsProposalValidationError

Converts to this type from the input type.

impl From<LibraryError> for KeyPackageNewError

fn from(source: LibraryError) -> KeyPackageNewError

Converts to this type from the input type.

impl From<LibraryError> for KeyPackageVerifyError

fn from(source: LibraryError) -> KeyPackageVerifyError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for LeafNodeUpdateError<StorageError>

fn from(source: LibraryError) -> LeafNodeUpdateError<StorageError>

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for LeaveGroupError<StorageError>

fn from(source: LibraryError) -> LeaveGroupError<StorageError>

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for MergeCommitError<StorageError>

fn from(source: LibraryError) -> MergeCommitError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for MessageDecryptionError

fn from(source: LibraryError) -> MessageDecryptionError

Converts to this type from the input type.

impl From<LibraryError> for MlsGroupStateError

fn from(source: LibraryError) -> MlsGroupStateError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for NewGroupError<StorageError>

fn from(source: LibraryError) -> NewGroupError<StorageError>

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for ProcessMessageError<StorageError>

fn from(source: LibraryError) -> ProcessMessageError<StorageError>

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for ProposalError<StorageError>

fn from(source: LibraryError) -> ProposalError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for ProposalValidationError

fn from(source: LibraryError) -> ProposalValidationError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for ProposeAddMemberError<StorageError>

fn from(source: LibraryError) -> ProposeAddMemberError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for ProposePskError

fn from(source: LibraryError) -> ProposePskError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for ProposeRemoveMemberError<StorageError>

fn from(source: LibraryError) -> ProposeRemoveMemberError<StorageError>

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for ProposeSelfUpdateError<StorageError>

fn from(source: LibraryError) -> ProposeSelfUpdateError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for PskError

fn from(source: LibraryError) -> PskError

Converts to this type from the input type.

impl From<LibraryError> for PublicGroupBuildError

fn from(source: LibraryError) -> PublicGroupBuildError

Converts to this type from the input type.

impl From<LibraryError> for PublicProcessMessageError

fn from(source: LibraryError) -> PublicProcessMessageError

Converts to this type from the input type.

impl From<LibraryError> for PublicTreeError

fn from(source: LibraryError) -> PublicTreeError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for RemoveMembersError<StorageError>

fn from(source: LibraryError) -> RemoveMembersError<StorageError>

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for SelfUpdateError<StorageError>

fn from(source: LibraryError) -> SelfUpdateError<StorageError>

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for SetupError<StorageError>

fn from(source: LibraryError) -> SetupError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for StageCommitError

fn from(source: LibraryError) -> StageCommitError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for SwapMembersError<StorageError>

fn from(source: LibraryError) -> SwapMembersError<StorageError>

Converts to this type from the input type.

impl From<LibraryError> for TreeSyncAddLeaf

fn from(source: LibraryError) -> TreeSyncAddLeaf

Converts to this type from the input type.

impl From<LibraryError> for TreeSyncFromNodesError

fn from(source: LibraryError) -> TreeSyncFromNodesError

Converts to this type from the input type.

impl From<LibraryError> for ValidationError

fn from(source: LibraryError) -> ValidationError

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for WelcomeError<StorageError>

fn from(source: LibraryError) -> WelcomeError<StorageError>

Converts to this type from the input type.

impl PartialEq for LibraryError

fn eq(&self, other: &LibraryError) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 LibraryError

impl StructuralPartialEq for LibraryError

Auto Trait Implementations§

impl Freeze for LibraryError

impl RefUnwindSafe for LibraryError

impl Send for LibraryError

impl Sync for LibraryError

impl Unpin for LibraryError

impl UnwindSafe for LibraryError

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Classify for T

type Classified = T

fn classify(self) -> T

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> Declassify for T

type Declassified = T

fn declassify(self) -> T

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> ToStringFallible for T
where T: Display,

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more