Skip to main content

Pattern

Struct Pattern 

Source
pub struct Pattern { /* private fields */ }
Expand description

A wildcard byte pattern with parsed-from-string ergonomics.

Internally just a Vec<Option<u8>> for owned, runtime-built patterns. For static / compile-time patterns prefer the crate::pattern! macro, which produces a &'static [Option<u8>] with no allocation.

§Examples

use pe_sigscan::Pattern;

let p = Pattern::from_ida("48 8B 05 ?? ?? ?? ?? 48 89 41 08").unwrap();
assert_eq!(p.len(), 11);
assert_eq!(p.as_slice()[0], Some(0x48));
assert_eq!(p.as_slice()[3], None);

Implementations§

Source§

impl Pattern

Source

pub fn new(bytes: Vec<Option<u8>>) -> Self

Construct a pattern from an existing Vec<Option<u8>>.

Useful when the pattern is built programmatically (e.g. mutating an existing Vec<Option<u8>> to add wildcards before scanning).

Source

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

Parse an IDA-style hex pattern string.

Accepted token shapes (case-insensitive, separated by ASCII whitespace):

  • XX — two hex digits, matches the literal byte 0xXX.
  • ? or ?? — wildcard, matches any byte.
§Examples
use pe_sigscan::Pattern;
let p = Pattern::from_ida("48 8B ?? 89").unwrap();
assert_eq!(p.as_slice(), &[Some(0x48), Some(0x8B), None, Some(0x89)]);
§Errors

Returns ParsePatternError if the input contains a token that is neither two hex digits nor ? / ??, or if a token mixes ? with hex characters (?A, 1?).

Source

pub fn as_slice(&self) -> WildcardPattern<'_>

View the pattern as a WildcardPattern. Use this when calling the scan functions: find_in_text(base, pat.as_slice()).

Source

pub fn len(&self) -> usize

Number of byte slots in the pattern (literal + wildcard).

Source

pub fn is_empty(&self) -> bool

true if the pattern is empty.

Trait Implementations§

Source§

impl Clone for Pattern

Source§

fn clone(&self) -> Pattern

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Pattern

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Pattern

Source§

fn eq(&self, other: &Pattern) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Pattern

Source§

impl StructuralPartialEq for Pattern

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.