Struct ByteFilter

pub struct ByteFilter {
    pub mask: u8,
    pub value: u8,
}

A filter that matches a single byte.

A value b matches the filter if (b & self.mask) == self.value.

Fields

mask: u8

The mask applied to the byte value.

If a bit is 1, it indicates the bit must be matched to value. If it is 0, the bit can be ignored. In other words: the filter matches if (X & mask) == value

value: u8

The value to which the byte value is compared after masking.

Implementations

impl ByteFilter

pub fn new(mask: u8, value: u8) -> Self

Creates a new ByteFilter.

pub fn matches(&self, value: u8) -> bool

Returns true if value matches the ByteFilter.

pub fn max_matching_val(&self) -> u8

Returns the largest value matched by the filter.

pub fn min_matching_val(&self) -> u8

Returns the smallest value matched by the filter.

pub fn matches_anything(&self) -> bool

Returns true if all 256 possible values for an u8 match this filter.

pub fn covers(&self, other: &ByteFilter) -> bool

Returns true if all instructions matched by other are also matched by self

pub fn can_intersect(&self, other: &ByteFilter) -> bool

Returns true if the filters overlap.

pub fn can_merge(&self, other: &ByteFilter) -> bool

Returns true if the other filter can be merged into self.

pub fn merge(&mut self, other: &ByteFilter)

Merges the other filter into self.

pub fn can_exclude(&self, other: &ByteFilter) -> bool

Returns true if self - other can be computed.

pub fn exclude(&mut self, other: &ByteFilter)

Computes self - other.

pub fn intersect(&mut self, other: &ByteFilter)

Intersects self with other, storing the result in self.

pub fn num_wildcard_bits(&self) -> usize

Returns the number of wildcard bits in the filter.

pub fn as_value(&self) -> Option<u8>

Returns the value matched by the filter, if the filter does not contain any wildcard bits. Otherwise, returns None.

Trait Implementations

impl Clone for ByteFilter

fn clone(&self) -> ByteFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ByteFilter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ByteFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ByteFilter

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 JsonSchema for ByteFilter

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for ByteFilter

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ByteFilter

impl StructuralPartialEq for ByteFilter