Struct CommandMatch

pub struct CommandMatch {
    pub command: Command,
    pub mask: [u8; 64],
}

A versatile definition to command match NVMe commands

Matches NVMe commands using a 512-bit mask: (command_bytes & mask) == (pattern_bytes & mask). A convenient way to build the patterns is to treat both the command and the mask as nvme_spec::Command and max out the fields in the mask that should be matched.

Example

Builds a command match that matches on all CREATE_IO_COMPLETION_QUEUE admin commands.

use nvme_resources::fault::CommandMatch;
use nvme_spec::Command;
use zerocopy::FromZeros;
use zerocopy::IntoBytes;

pub fn build_command_match() -> CommandMatch {
    let mut command = Command::new_zeroed();
    let mut mask = Command::new_zeroed();
    command.cdw0 = command.cdw0.with_opcode(nvme_spec::AdminOpcode::CREATE_IO_COMPLETION_QUEUE.0);
    mask.cdw0 = mask.cdw0.with_opcode(u8::MAX);
    CommandMatch {
        command,
        mask: mask.as_bytes().try_into().expect("mask should be 64 bytes"),
    }
}

Fields

command: Command

Command to match against

mask: [u8; 64]

Bitmask that defines the bits to match against

Trait Implementations

impl Clone for CommandMatch

fn clone(&self) -> CommandMatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DefaultEncoding for CommandMatch

type Encoding = TableEncoder

The encoding to use for the serialization.

impl PartialEq for CommandMatch

fn eq(&self, other: &CommandMatch) -> 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<'encoding> StructDecodeMetadata<'encoding, Resource> for CommandMatch

const DECODERS: &'static [ErasedDecoderEntry]

The list of decoder vtables.

impl StructEncodeMetadata<Resource> for CommandMatch

const ENCODERS: &'static [ErasedEncoderEntry]

The list of encoder vtables.

impl StructMetadata for CommandMatch

const NUMBERS: &'static [u32]

The field numbers for each field.

const OFFSETS: &'static [usize]

The byte offset to each field within the struct.

impl StructuralPartialEq for CommandMatch