Enum Error 

pub enum Error {
    AlphabetMultibyteCharacters,
    AlphabetLength,
    AlphabetUniqueCharacters,
    BlocklistMaxAttempts,
}

sqids Error type.

Variants

AlphabetMultibyteCharacters

Alphabet cannot contain multibyte characters

let error = Sqids::builder().alphabet("☃️🦀🔥".chars().collect()).build().unwrap_err();
assert_eq!(error, Error::AlphabetMultibyteCharacters);

AlphabetLength

Alphabet length must be at least 3

let error = Sqids::builder().alphabet("ab".chars().collect()).build().unwrap_err();
assert_eq!(error, Error::AlphabetLength);

AlphabetUniqueCharacters

Alphabet must contain unique characters

let error = Sqids::builder().alphabet("aba".chars().collect()).build().unwrap_err();
assert_eq!(error, Error::AlphabetUniqueCharacters);

BlocklistMaxAttempts

Reached max attempts to re-generate the ID

let sqids = Sqids::builder()
	.alphabet("abc".chars().collect())
	.min_length(3)
	.blocklist(["aac".to_string(), "bba".to_string(), "ccb".to_string()].into())
	.build()
	.unwrap();
let error = sqids.encode(&[1]).unwrap_err();
assert_eq!(error, Error::BlocklistMaxAttempts);

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

fn eq(&self, other: &Error) -> 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 Error

impl StructuralPartialEq for Error