Struct Instruction

pub struct Instruction { /* private fields */ }

An instruction bitstring. Can contain instructions up to 15 bytes long.

Implementations

impl Instruction

pub const fn new(data: &[u8]) -> Instruction

Creates a new instruction from the provided slice. The slice must be 15 bytes or less.

pub fn into_string(&self) -> String

Converts the instruction into an uppercase hexadecimal string.

pub fn starts_with(&self, p: &Instruction) -> bool

Returns true if the instruction starts with the prefix p, followed by zero or more additional bytes.

pub fn set_nth_bit_from_right(&mut self, index: usize, bit: u8)

Sets the bit at position index, counting from the right.

bit must be 0 or 1.

pub fn set_multiple_bits_from_right( &mut self, index: usize, data: u64, num: usize, )

Sets multiple bits starting at position index, counting from the right and moving to the left. Shifts new bits to insert out of data. The lowest bit in data is inserted first.

impl Instruction

pub fn bytes(&self) -> &[u8]

Returns a slice containing the bytes of the instruction.

pub fn byte_len(&self) -> usize

Returns the number of bytes in the instruction.

pub fn bit_len(&self) -> usize

Returns the number of bits in the instruction.

pub fn with_nth_bit_from_right_flipped(&self, index: usize) -> Instruction

Returns an instruction where the bit at position index, counting from the right, is flipped.

pub fn with_nth_bit_from_right(&self, index: usize, bit: u8) -> Instruction

Replaces the bit at position index, counting from the right, with bit. bit must be 0 or 1.

pub fn with_nth_bit_from_left(&self, index: usize, bit: u8) -> Instruction

Replaces the bit at position index, counting from the left, with bit. bit must be 0 or 1.

pub fn extend(&self) -> Instruction

Extends the instruction with one extra 0-byte. The instruction must be 15 bytes or less.

pub fn resize(&self, num_bytes: usize, fill: u8) -> Instruction

Resizes the instruction to be num_bytes long. If this is longer than the current instruction, new bytes are filled with the value fill.

pub fn with_rightmost_bits(&self, num: usize, bit: u8) -> Instruction

Replaces the num rightmost bits in the instruction with value bit.

pub fn nth_bit_from_right(&self, index: usize) -> u8

Returns the value of the bit at position index, counting from the right.

pub fn nth_bit_from_left(&self, index: usize) -> u8

Returns the value of the bit at position index, counting from the left.

Trait Implementations

impl<'a> Arbitrary<'a> for Instruction

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Instruction

fn deserialize<D>(deserializer: D) -> Result<Instruction, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a [u8]> for Instruction

fn from(data: &'a [u8]) -> Self

Converts to this type from the input type.

impl From<&Instruction> for InstructionFilter

fn from(instr: &Instruction) -> Self

Converts to this type from the input type.

impl From<&str> for Instruction

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Instruction> for InstructionFilter

fn from(instr: Instruction) -> Self

Converts to this type from the input type.

impl FromIterator<u8> for Instruction

fn from_iter<T: IntoIterator<Item = u8>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for Instruction

type Err = FromHexError

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.

impl Hash for Instruction

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 Instruction

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 LowerHex for Instruction

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

Formats the value using the given formatter.

impl Ord for Instruction

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

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

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl UpperHex for Instruction

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

Formats the value using the given formatter.

impl Copy for Instruction

impl Eq for Instruction