Struct Pattern

pub struct Pattern<const ALIGNMENT: usize = 1, const BYTES: usize = DEFAULT_BYTES>
where
    LaneCount<ALIGNMENT>: SupportedLaneCount,
    LaneCount<BYTES>: SupportedLaneCount,
{ /* private fields */ }

A prepared pattern. Allows to search for a given byte sequence in data. Supports masking and alignment requirements.

BYTES determines the LANES size. Every block of data is processed in chunks of BYTES bytes. Rust will compile this to other targets without issue, but will use inner loops for that. It is also the max length for patterns.

Implementations

impl<const ALIGNMENT: usize, const BYTES: usize> Pattern<ALIGNMENT, BYTES>

where LaneCount<ALIGNMENT>: SupportedLaneCount, LaneCount<BYTES>: SupportedLaneCount,

pub const fn new(pattern: &str) -> Self

Parse a pattern. Use Pattern::from_str to return an error instead of panicking.

Panics

Panics if ParsePatternError is returned.

pub fn from_slice(bytes: &[u8], mask: u64) -> Self

Create a pattern from a byte slice and a mask. Byte slices longer than BYTES are cut short. Mask expects a u64 bitencoding. A 0 bit marks the byte as wildcard. Mask is trimmed to bytes.len().

Panics

Panics when all bytes are masked as wildcards.

pub const fn from_str(s: &str) -> Result<Self, ParsePatternError>

Parses a string to a pattern.

Expected format:

? 1A . B4 ?? e0 .. 5f

? and . mark wildcards. Only the first character is checked for wildcards. 10 .error 00 is equivalent to 10 ? 00.

pub fn matches<'pattern, 'data>( &'pattern self, data: &'data [u8], ) -> Scanner<'pattern, 'data, ALIGNMENT, BYTES>

Creates an Iterator over data.

Trait Implementations

impl<const ALIGNMENT: usize, const BYTES: usize> Clone for Pattern<ALIGNMENT, BYTES>

where LaneCount<ALIGNMENT>: SupportedLaneCount, LaneCount<BYTES>: SupportedLaneCount,

fn clone(&self) -> Pattern<ALIGNMENT, BYTES>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const ALIGNMENT: usize, const BYTES: usize> Debug for Pattern<ALIGNMENT, BYTES>

where LaneCount<ALIGNMENT>: SupportedLaneCount, LaneCount<BYTES>: SupportedLaneCount,

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

Formats the value using the given formatter.

impl<const ALIGNMENT: usize, const BYTES: usize> FromStr for Pattern<ALIGNMENT, BYTES>

where LaneCount<ALIGNMENT>: SupportedLaneCount, LaneCount<BYTES>: SupportedLaneCount,

type Err = ParsePatternError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.