Struct ZffError 

pub struct ZffError { /* private fields */ }

The main error-type of this crate.

Implementations

impl ZffError

pub fn new<S: Into<String>>(kind: ZffErrorKind, details: S) -> ZffError

Creates a new crate-related error.

Example

use zff::{ZffError, ZffErrorKind, Result};
fn my_func() -> Result<()> {
    let custom_error = ZffError::new(
                               ZffErrorKind::Custom, "My detailed custom error message");
       Err(custom_error)
}
fn main() {
       match my_func() {
           Err(x) => println!("It work's! Your custom error message is: {}", x),
           _ => ()
       }
}

pub fn new_custom<S: Into<String>>(details: S) -> ZffError

Creates a new crate-related custom error.

Example

use zff::{ZffError, Result};
fn my_func() -> Result<()> {
    let custom_error = ZffError::new_custom("My detailed custom error message");
       Err(custom_error)
}
fn main() {
       match my_func() {
           Err(x) => println!("It work's! Your custom error message is: {}", x),
           _ => ()
       }
}

pub fn new_header_decode_error<S: Into<String>>(details: S) -> ZffError

Creates a new crate-related header decode error.

Example

use zff::{ZffError, Result};
fn my_func() -> Result<()> {
    let decode_error = ZffError::new_header_decode_error("error while trying to decode CompressionHeader from given data");
       Err(decode_error)
}
fn main() {
       match my_func() {
           Err(x) => println!("It work's! Your custom error message is: {}", x),
           _ => ()
       }
}

pub fn get_kind(&self) -> &ZffErrorKind

Returns a reference to the kind.

Example

use zff::{ZffError, ZffErrorKind, Result};
fn my_func() -> Result<()> {
    let custom_error = ZffError::new_custom("My detailed custom error message");
       Err(custom_error)
}
fn main() {
    match my_func() {
        Err(x) => {
            assert!(matches!(x.get_kind(), &ZffErrorKind::Custom));
        },
        _ => ()
    }
}

pub fn unwrap_kind(self) -> ZffErrorKind

returns the error kind and consumes self.

Example

use zff::{ZffError, ZffErrorKind, Result};
fn my_func() -> Result<()> {
    let custom_error = ZffError::new_custom("My detailed custom error message");
       Err(custom_error)
}
fn main() {
    match my_func() {
        Err(x) => {
            assert!(matches!(x.unwrap_kind(), ZffErrorKind::Custom));
        },
        _ => ()
    }
}

Trait Implementations

impl Debug for ZffError

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

Formats the value using the given formatter.

impl Display for ZffError

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

Formats the value using the given formatter.

impl From<ComponentRange> for ZffError

fn from(e: ComponentRangeError) -> ZffError

Converts to this type from the input type.

impl From<DecodeError> for ZffError

fn from(e: Base64DecodingError) -> ZffError

Converts to this type from the input type.

impl From<Error> for ZffError

fn from(e: Error) -> ZffError

Converts to this type from the input type.

impl From<Error> for ZffError

fn from(e: PKCS5CryptoError) -> ZffError

Converts to this type from the input type.

impl From<Error> for ZffError

fn from(e: EncryptionError) -> ZffError

Converts to this type from the input type.

impl From<Error> for ZffError

fn from(e: Lz4Error) -> ZffError

Converts to this type from the input type.

impl From<Error> for ZffError

fn from(e: Ed25519Error) -> ZffError

Converts to this type from the input type.

impl From<FromUtf8Error> for ZffError

fn from(e: FromUtf8Error) -> ZffError

Converts to this type from the input type.

impl From<InvalidParams> for ZffError

fn from(e: ScryptErrorInvalidParams) -> ZffError

Converts to this type from the input type.