Struct LibraryError

pub struct LibraryError { /* private fields */ }

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 copy of the value.

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

Performs copy-assignment from source.

impl Debug for LibraryError

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

Formats the value using the given formatter.

impl Display for LibraryError

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

Formats the value using the given formatter.

impl Error for LibraryError

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

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

fn description(&self) -> &str

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

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.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for ApplyUpdatePathError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for CreateAddProposalError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for CreateCommitError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for CreateMessageError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for CredentialError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for ExportGroupInfoError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for ExportSecretError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for ExtensionError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for ExternalCommitValidationError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for GroupContextExtensionsProposalValidationError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for KeyPackageNewError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for KeyPackageVerifyError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for MessageDecryptionError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for MlsGroupStateError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for ProcessMessageError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for ProposalValidationError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for ProposePskError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for PskError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for PublicGroupBuildError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for PublicTreeError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for StageCommitError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for TreeSyncAddLeaf

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for TreeSyncFromNodesError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for ValidationError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

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

fn from(source: LibraryError) -> Self

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 ==.

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