Enum VectorscanRuntimeError

#[repr(i8)]
pub enum VectorscanRuntimeError {
    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 vectorscan 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 Vectorscan.

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 Vectorscan is able to detect that the scratch region given is already in use by another Vectorscan API call.

A separate scratch region, allocated with Scratch::setup_for_db() or Scratch::try_clone(), is required for every concurrent caller of the Vectorscan 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. See crate::state for ways to manage scratch spaces.

ArchError = -11

Unsupported CPU architecture.

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

At a minimum, Vectorscan 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 VectorscanRuntimeError

fn clone(&self) -> VectorscanRuntimeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorscanRuntimeError

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

Formats the value using the given formatter.

impl Display for VectorscanRuntimeError

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

Formats the value using the given formatter.

impl Error for VectorscanRuntimeError

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<VectorscanRuntimeError> for ChimeraError

Available on crate feature chimera only.

fn from(source: VectorscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<VectorscanRuntimeError> for CompressionError

fn from(source: VectorscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<VectorscanRuntimeError> for ScanError

fn from(source: VectorscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<VectorscanRuntimeError> for VectorscanCompileError

fn from(source: VectorscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<VectorscanRuntimeError> for VectorscanError

fn from(source: VectorscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<VectorscanRuntimeError> for i8

fn from(enum_value: VectorscanRuntimeError) -> Self

Converts to this type from the input type.

impl From<i8> for VectorscanRuntimeError

fn from(number: i8) -> Self

Converts to this type from the input type.

impl FromPrimitive for VectorscanRuntimeError

type Primitive = i8

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

impl Hash for VectorscanRuntimeError

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 VectorscanRuntimeError

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

Restrict a value to a certain interval.

impl PartialEq for VectorscanRuntimeError

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for VectorscanRuntimeError

impl Eq for VectorscanRuntimeError

impl StructuralPartialEq for VectorscanRuntimeError