Struct GenericBinaryPattern 

pub struct GenericBinaryPattern<'a> { /* private fields */ }

A flexible implementation of the BinaryPattern interface supporting both borrowed and owned data.

This struct uses alloc::borrow::Cow for both the Atom array and the byte sequence, allowing it to either borrow data without allocation or own it when necessary. This design makes it suitable for both compile-time defined and runtime-parsed patterns.

Example

let atoms = &[Atom::ByteSequence { seq_start: 0x00, seq_end: 0x01 }];
let bytes = &[0x90];

// Borrowed (no allocation)
let borrowed = GenericBinaryPattern::new(atoms, bytes);

// Owned (allocating)
let owned = GenericBinaryPattern::new(vec![Atom::ByteSequence { seq_start: 0x00, seq_end: 0x01 }], vec![0x90]);

Implementations

impl<'a> GenericBinaryPattern<'a>

pub fn new( atoms: impl Into<Cow<'a, [Atom]>>, byte_sequence: impl Into<Cow<'a, [u8]>>, ) -> Self

Creates a new GenericBinaryPattern from borrowed or owned data.

This constructor accepts any type that can be converted into a Cow, such as slices or vectors.
Borrowed inputs (&[Atom], &[u8]) avoid allocation, while owned inputs (Vec<Atom>, Vec<u8>) store the data internally.

pub const fn new_const(atoms: &'a [Atom], byte_sequence: &'a [u8]) -> Self

Creates a borrowed GenericBinaryPattern from static references.

This constructor is const and does not perform any heap allocation. It is ideal for defining patterns that reference constant or static data.

pub fn into_owned(self) -> GenericBinaryPattern<'static>

Converts the pattern into an owned version with a 'static lifetime.

Any borrowed data is cloned into owned memory, ensuring that the returned pattern no longer depends on the original lifetimes.
This is useful when the pattern needs to outlive temporary references.

Trait Implementations

impl BinaryPattern for GenericBinaryPattern<'_>

fn atoms(&self) -> &[Atom]

Retrieves the list of atoms within this binary pattern.

fn byte_sequence(&self) -> &[u8]

Retrieves the byte sequence referenced by the atoms.

fn save_len(&self) -> usize

Returns an upper bound for the length of the save stack.

fn cursor_len(&self) -> usize

Returns an upper bound for the length of the cursor stack.

impl<'a> Clone for GenericBinaryPattern<'a>

fn clone(&self) -> GenericBinaryPattern<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for GenericBinaryPattern<'a>

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

Formats the value using the given formatter.