Struct Mode

pub struct Mode(/* private fields */);

Available on crate feature compiler only.

Compiler mode flags that affect the database as a whole.

No Default impl is provided, to enforce that at least one of STREAM, BLOCK, or VECTORED is supplied, to select between the generation of a streaming, block or vectored database. In addition, other flags may be supplied to enable or configure specific features such as stream state size. Multiple flags may be used by ORing them together.

Implementations

impl Mode

Basic Database Types

For now, each database can only be one of these types (this is checked by vectorscan upon database creation).

pub const BLOCK: Self

Block scan (non-streaming) database.

pub const NOSTREAM: Self

Alias for BLOCK.

pub const VECTORED: Self

Available on crate feature vectored only.

Vectored scanning database.

pub const STREAM: Self

Available on crate feature stream only.

Streaming database.

impl Mode

Stream State Precision Modes

These flags are currently only processed when Self::STREAM is requested.

pub const SOM_HORIZON_LARGE: Self

Available on crate feature stream only.

Use full precision to track start of match offsets in stream state.

This mode will use the most stream state per pattern, but will always return an accurate start of match offset regardless of how far back in the past it was found.

One of the SOM_HORIZON_* modes must be selected to use the Flags::SOM_LEFTMOST expression flag.

pub const SOM_HORIZON_MEDIUM: Self

Available on crate feature stream only.

Use medium precision to track start of match offsets in stream state.

This mode will use less stream state than Self::SOM_HORIZON_LARGE and will limit start of match accuracy to offsets within 2^32 bytes of the end of match offset reported.

One of the SOM_HORIZON_* modes must be selected to use the Flags::SOM_LEFTMOST expression flag.

pub const SOM_HORIZON_SMALL: Self

Available on crate feature stream only.

Use limited precision to track start of match offsets in stream state.

This mode will use less stream state than Self::SOM_HORIZON_LARGE and will limit start of match accuracy to offsets within 2^16 bytes of the end of match offset reported.

One of the SOM_HORIZON_* modes must be selected to use the Flags::SOM_LEFTMOST expression flag.

Trait Implementations

impl BitAnd for Mode

type Output = Mode

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for Mode

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for Mode

type Output = Mode

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for Mode

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitSet for Mode

fn nonzero(&self) -> bool

Whether the underlying integer storing this bitset is not equal to 0.

fn contains(&self, other: &Self) -> bool

Whether the other flag was provided to the current bitset.

impl Clone for Mode

fn clone(&self) -> Mode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mode

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

Formats the value using the given formatter.

impl Hash for Mode

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 Not for Mode

type Output = Mode

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Mode

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

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

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

impl Eq for Mode

impl StructuralPartialEq for Mode