Enum hyperscan::chimera::prelude::Error

pub enum Error {
    Invalid,
    NoMem,
    ScanTerminated,
    CompileError(CompileError),
    CompilerError,
    DbVersionError,
    DbPlatformError,
    DbModeError,
    BadAlign,
    BadAlloc,
    ScratchInUse,
    UnknownError,
    FailInternal,
    UnknownHSError,
    Code(ch_error_t),
}

A type for errors returned by Chimera functions.

Variants

Invalid

A parameter passed to this function was invalid.

NoMem

A memory allocation failed.

ScanTerminated

The engine was terminated by callback.

This return value indicates that the target buffer was partially scanned, but that the callback function requested that scanning cease after a match was located.

CompileError(CompileError)

The pattern compiler failed, and the ch_compile_error_t should be inspected for more detail.

CompilerError

The pattern compiler failed.

DbVersionError

The given database was built for a different version of the Chimera matcher.

DbPlatformError

The given database was built for a different platform (i.e., CPU type).

DbModeError

The given database was built for a different mode of operation.

This error is returned when streaming calls are used with a non-streaming database and vice versa.

BadAlign

A parameter passed to this function was not correctly aligned.

BadAlloc

The memory allocator did not correctly return memory suitably aligned for the largest representable data type on this platform.

ScratchInUse

The scratch region was already in use.

This error is returned when Chimera is able to detect that the scratch region given is already in use by another Chimera API call.

A separate scratch region, allocated with @ref ch_alloc_scratch() or @ref ch_clone_scratch(), is required for every concurrent caller of the Chimera API.

For example, this error might be returned when @ref ch_scan() has been called inside a callback delivered by a currently-executing @ref ch_scan() call using the same scratch region.

Note: Not all concurrent uses of scratch regions may be detected. This error is intended as a best-effort debugging tool, not a guarantee.

UnknownError

Unexpected internal error from Hyperscan.

This error indicates that there was unexpected matching behaviors from Hyperscan. This could be related to invalid usage of scratch space or invalid memory operations by users.

FailInternal

Returned when pcre_exec (called for some expressions internally from ch_scan) failed due to a fatal error.

UnknownHSError

Unexpected internal error from Hyperscan.

This error indicates that there was unexpected matching behaviors from Hyperscan. This could be related to invalid usage of scratch space or invalid memory operations by users.

Code(ch_error_t)

Unknown error code

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)>

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 self, demand: &mut Demand<'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.

impl From<i32> for Error

fn from(err: ch_error_t) -> Self

Converts to this type from the input type.

impl PartialEq<Error> for Error

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Error

impl StructuralEq for Error

impl StructuralPartialEq for Error