Enum Error 

#[non_exhaustive]
pub enum Error {
    FileNotFound {
        file: String,
    },
    InvalidMagic {
        context: MagicContext,
    },
    InvalidCheckSum {
        file: String,
        computed: [u8; 16],
    },
    BadDecryptKey,
    WrongPasscode,
    BadEncryptedDataSize {
        size: usize,
    },
    BadDecryptedDataSize {
        encrypted_size: usize,
        full_len: usize,
        decrypted_size: usize,
    },
    BadConfigData {
        context: ConfigFailure,
    },
    QDataStreamFailed {
        context: Option<&'static str>,
    },
    ReadMapDataFailed {
        context: MapReadFailure,
    },
    ReadMapDataIncorrectPasscode,
    AuthKeyNotFound,
    MaxAccountLimit,
    SaveFailed,
    KeyDataInvalid {
        context: KeyDataFailure,
    },
    BadLength {
        what: &'static str,
        expected: usize,
        actual: usize,
    },
    InvalidInput {
        what: &'static str,
        reason: String,
    },
    Io(Error),
}

Every failure the core can report.

Variants map 1:1 onto the tdata exceptions of the Python package (opentele2.exception), plus Error::BadLength, Error::InvalidInput and Error::Io. Bindings dispatch on Error::code, which is stable across releases; the Display text is for humans and may change. Error::legacy_message is the message of the matching exception, built from the context the variants carry.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

FileNotFound

A required tdata file does not exist (TFileNotFound).

Fields

file: String

The file name without its suffix, or the path that was looked for.

InvalidMagic

A tdata file does not start with the TDF$ magic, or the MTP data holds an unknown block (TDataInvalidMagic).

Fields

context: MagicContext

Where the bad magic was found.

InvalidCheckSum

A tdata file’s MD5 checksum does not match its contents (TDataInvalidCheckSum).

Fields

file: String

The file name without its suffix; empty when the bytes were parsed without a name (crate::tdf::TdfFile::parse).

computed: [u8; 16]

The MD5 computed over the contents, which the stored one does not match.

BadDecryptKey

Decryption produced data that does not match its key (TDataBadDecryptKey).

WrongPasscode

The local passcode does not unlock the tdata (TDataWrongPasscode).

BadEncryptedDataSize

Encrypted data has a size that is not valid for AES-IGE (TDataBadEncryptedDataSize).

Fields

size: usize

The size of the encrypted data, in bytes.

BadDecryptedDataSize

Decrypted data declares a size that does not fit the buffer (TDataBadDecryptedDataSize).

Fields

encrypted_size: usize

The size of the encrypted data, in bytes.

full_len: usize

The encrypted size without the 16-byte message key.

decrypted_size: usize

The size of the decrypted buffer, in bytes.

BadConfigData

The config block of a tdata file cannot be parsed (TDataBadConfigData).

Fields

context: ConfigFailure

Which check of the config failed.

QDataStreamFailed

A QDataStream read or write failed (QDataStreamFailed).

Fields

context: Option<&'static str>

The message of the failed read, when the read has a message of its own; None gives the default Could not stream data.

ReadMapDataFailed

The account map data cannot be read (TDataReadMapDataFailed).

Fields

context: MapReadFailure

Which step of the read failed.

ReadMapDataIncorrectPasscode

The account map data was read with an incorrect passcode (TDataReadMapDataIncorrectPasscode).

AuthKeyNotFound

No authorization key was found in the tdata (TDataAuthKeyNotFound).

MaxAccountLimit

The account limit of Telegram Desktop is reached (MaxAccountLimit).

SaveFailed

Writing the tdata failed (TDataSaveFailed).

KeyDataInvalid

The key_<dataName> file is malformed or uses parameters that cannot make a passcode key (TDataKeyDataInvalid).

Fields

context: KeyDataFailure

Which check of the key data failed.

BadLength

A buffer, key, or IV has the wrong length.

Fields

what: &'static str

Name of the value whose length is wrong.

expected: usize

Length the operation requires, in bytes.

actual: usize

Length the caller supplied, in bytes.

InvalidInput

A caller-supplied argument is outside what the operation accepts, for a reason other than its length (that is Error::BadLength).

Fields

what: &'static str

Name of the argument that was rejected.

reason: String

Why the argument was rejected.

Io(Error)

An I/O operation on a caller-supplied path failed.

Implementations

impl Error

pub fn code(&self) -> &'static str

Stable SCREAMING_SNAKE code identifying the variant, for example "TDATA_WRONG_PASSCODE". Bindings map this code onto their own error types; it never changes for an existing variant.

pub fn detail_code(&self) -> Option<&'static str>

Stable SCREAMING_SNAKE code of the context of an error whose context a binding raises differently from the rest of its Error::code, else None. It never changes once given.

• "BAD_ACCOUNTS_COUNT": Error::KeyDataInvalid with KeyDataFailure::BadAccountsCount, which is raised as a plain OpenTeleException rather than TDataKeyDataInvalid.

Every other error has no detail code.

pub fn legacy_message(&self) -> String

The message of the matching exception (its message attribute, without the class name and caller str() adds), for example Invalid magic b'ABCD' in file maps.

• Error::FileNotFound: Could not open {file}.
• Error::InvalidMagic: Invalid magic {magic!r} in file {file}, the magic as a Python bytes literal; for an MTP data block Unsupported block id in MtpData: {block_id}.
• Error::InvalidCheckSum: Invalid checksum {md5 hex} in file {file}.
• Error::BadEncryptedDataSize and Error::BadDecryptedDataSize: the Storage.DecryptLocal messages with their sizes.
• Error::BadDecryptKey: the Storage.DecryptLocal message, for key-data steps too.
• Error::QDataStreamFailed: the context, else the default Could not stream data.
• Error::ReadMapDataFailed, Error::ReadMapDataIncorrectPasscode, Error::AuthKeyNotFound and Error::MaxAccountLimit: the MapData.read, _findMainAuthKey and FromTelethon messages.
• Error::KeyDataInvalid: the read_key_data, create_passcode_key and __loadFromTData message of its context.
• Error::SaveFailed: Could not save tdata, something went wrong, the one message of SaveTData.
• Error::BadConfigData: the constructFromSerialized, MTP.Config.FromSerialized, MTP.Config.endpoints and FromTDesktop message of its context (for the IP and environment checks the Python 3.8 UnicodeDecodeError and ValueError text), and a plain description for the endpoint, session and self-user checks.

Error::WrongPasscode, Error::BadLength, Error::InvalidInput (Invalid {what}: {reason}) and Error::Io give their Display text.

pub fn legacy_class(&self) -> &'static str

The class name of the exception raised for the failure, the single source the bindings name their errors after (the Python CORE_ERROR_TYPES table, the Node error name).

Each tdata variant gives the opentele2.exception class its doc names, for example TDataWrongPasscode; Error::KeyDataInvalid with KeyDataFailure::BadAccountsCount (Error::detail_code BAD_ACCOUNTS_COUNT) gives OpenTeleException. The variants with no opentele2 class of their own give a Python builtin: ValueError for Error::BadLength (as an AES-IGE backend raises) and Error::InvalidInput (as hashlib does), OSError for Error::Io.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.