Enum hyperscan::error::HyperscanRuntimeError

#[repr(i8)]
pub enum HyperscanRuntimeError {
    Invalid = -1,
    NoMem = -2,
    ScanTerminated = -3,
    CompilerError = -4,
    DbVersionError = -5,
    DbPlatformError = -6,
    DbModeError = -7,
    BadAlign = -8,
    BadAlloc = -9,
    ScratchInUse = -10,
    ArchError = -11,
    InsufficientSpace = -12,
    UnknownError = -13,
}

Native error code from the underlying hyperscan library.

Variants

Invalid = -1

A parameter passed to this function was invalid.

This error is only returned in cases where the function can detect an invalid parameter – it cannot be relied upon to detect (for example) pointers to freed memory or other invalid data.

NoMem = -2

A memory allocation failed.

ScanTerminated = -3

The engine was terminated by callback.

This return value indicates that the target buffer was partially scanned, but that the callback function returned MatchResult::CeaseMatching after a match was located.

CompilerError = -4

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

DbVersionError = -5

The given database was built for a different version of Hyperscan.

DbPlatformError = -6

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

DbModeError = -7

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

This error is returned when streaming calls are used with a block or vectored database and vice versa.

BadAlign = -8

A parameter passed to this function was not correctly aligned.

BadAlloc = -9

The memory allocator returned incorrectly aligned memory.

The memory allocator (either libc::malloc() or the allocator set with crate::alloc::set_allocator()) did not correctly return memory suitably aligned for the largest representable data type on this platform.

ScratchInUse = -10

The scratch region was already in use.

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

A separate scratch region, allocated with Scratch::setup_for_db() or Scratch::try_clone(), is required for every concurrent caller of the Hyperscan API.

For example, this error might be returned when scan_sync() has been called inside a callback delivered by a currently-executing scan_sync() 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.

Note: safe Rust code should never see this error; Arc::make_mut() is often an effective way to avoid this while preserving the ergonomics of a Clone and Send reference type. This approach is used in this library’s stream module.

ArchError = -11

Unsupported CPU architecture.

This error is returned when Hyperscan is able to detect that the current system does not support the required instruction set.

At a minimum, Hyperscan requires Supplemental Streaming SIMD Extensions 3 (SSSE3).

InsufficientSpace = -12

Provided buffer was too small.

This error indicates that there was insufficient space in the buffer. The call should be repeated with a larger provided buffer.

Note: in this situation, it is normal for the amount of space required to be returned in the same manner as the used space would have been returned if the call was successful.

This value is referenced internally in LiveStream::compress() when requesting the amount of memory to allocate for a compressed stream. Users of this library should never see this error when using the CompressReserveBehavior interface.

UnknownError = -13

Unexpected internal error.

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

Trait Implementations

impl Clone for HyperscanRuntimeError

fn clone(&self) -> HyperscanRuntimeError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HyperscanRuntimeError

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

Formats the value using the given formatter.

impl Display for HyperscanRuntimeError

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

Formats the value using the given formatter.

impl Error for HyperscanRuntimeError

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>(&'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<HyperscanRuntimeError> for CompressionError

fn from(source: HyperscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<HyperscanRuntimeError> for HyperscanCompileError

fn from(source: HyperscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<HyperscanRuntimeError> for HyperscanError

fn from(source: HyperscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<HyperscanRuntimeError> for ScanError

fn from(source: HyperscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<HyperscanRuntimeError> for i8

fn from(enum_value: HyperscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<i8> for HyperscanRuntimeError

fn from(number: i8) -> Self

Converts to this type from the input type.

impl FromPrimitive for HyperscanRuntimeError

type Primitive = i8

fn from_primitive(number: Self::Primitive) -> Self

impl Hash for HyperscanRuntimeError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for HyperscanRuntimeError

fn cmp(&self, other: &HyperscanRuntimeError) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for HyperscanRuntimeError

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

fn partial_cmp(&self, other: &HyperscanRuntimeError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for HyperscanRuntimeError

impl Eq for HyperscanRuntimeError

impl StructuralEq for HyperscanRuntimeError

impl StructuralPartialEq for HyperscanRuntimeError