Enum GeneratorError

#[non_exhaustive]
pub enum GeneratorError {
    FixedSizeMismatch,
    FixedSizeTooLarge,
    InputSizeTooLarge,
    OutputOverflow,
}

The error type representing an invalid or an unsupported operation of the generator.

Compatibility Note

Since the version 0.3, the representation of this enum is no longer specified as specific representation of this enum is not important.

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.

FixedSizeMismatch

The fixed size has a mismatch with either the previously set value or the final input size.

FixedSizeTooLarge

The fixed size is too large.

InputSizeTooLarge

The total input size on finalization is too large.

OutputOverflow

The output would cause a buffer overflow for a specific output type.

This error only occurs when:

• Truncation is disabled,
• The output type is a short form
  (because of those conditions, it only occurs on a raw Generator::finalize_raw() call) and
• The resulting block hash 2 is longer than that of the short form limit (block_hash::HALF_SIZE).

Implementations

impl GeneratorError

pub fn is_size_too_large_error(&self) -> bool

Checks whether this error is raised by one of the “size too large” cases.

It returns true on either FixedSizeTooLarge or InputSizeTooLarge variants.

Trait Implementations

impl Clone for GeneratorError

fn clone(&self) -> GeneratorError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratorError

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

Formats the value using the given formatter.

impl Display for GeneratorError

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

Formats the value using the given formatter.

impl Error for GeneratorError

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<GeneratorError> for GeneratorOrIOError

Available on crate features std and easy-functions only.

fn from(value: GeneratorError) -> Self

Converts to this type from the input type.

impl PartialEq for GeneratorError

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

impl Eq for GeneratorError

impl StructuralPartialEq for GeneratorError