Enum Atom

pub enum Atom {
    ByteSequence {
        seq_start: u16,
        seq_end: u16,
    },
    ByteSequenceMasked {
        seq_start: u16,
        mask_start: u16,
        len: u16,
    },
    WildcardFixed(u16),
    WildcardRange {
        min: u16,
        max: u16,
    },
    Jump(JumpType),
    Read(ReadWidth),
    Branch {
        left_len: u16,
        right_len: u16,
    },
    CursorPush,
    CursorPop {
        advance: u16,
    },
    SaveCursor,
    SaveConstant(u32),
}

An atom represents a single operation that the matcher should perform.

Variants

ByteSequence

Match a sequence of bytes from the sequence array.

Fields

seq_start: u16

seq_end: u16

ByteSequenceMasked

Match a sequence of bytes from the sequence array using a custom bitmask.

Fields

seq_start: u16

Start of the byte sequence in the sequence array.

mask_start: u16

Start of the byte mask in the sequence array.

len: u16

Number of bytes to match

WildcardFixed(u16)

Skip a fixed number of bytes.

WildcardRange

Skip a variable number of bytes.

Fields

min: u16

max: u16

Jump(JumpType)

Jump to the relative / absolute based on the binary data the current cursor location.

Read(ReadWidth)

Read the data value of a specified size at the current cursors location and save it to the save stack. This also advances the data cursor by the specified size.

Branch

Match any one of the two subexpressions and then continue where we left of.

Fields

left_len: u16

Length of the left subpattern

right_len: u16

Length of the right subpattern

CursorPush

Push the cursor location to the cursor stack

CursorPop

Pop the cursor location from the cursor stack and advance by X bytes

Fields

advance: u16

SaveCursor

Save the current cursor position to the save stack

SaveConstant(u32)

Save the constant to the save stack. This can be usefull to save which branch has been taken.

Trait Implementations

impl Clone for Atom

fn clone(&self) -> Atom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Atom

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

Formats the value using the given formatter.

impl Ord for Atom

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

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

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

impl Eq for Atom

impl StructuralPartialEq for Atom