Enum SpiStep 

pub enum SpiStep {
    Write {
        bytes: Vec<u8>,
    },
    Read {
        reply: Vec<u8>,
    },
    Transfer {
        bytes: Vec<u8>,
        reply: Vec<u8>,
    },
    Fault {
        kind: ErrorKind,
    },
}

One transfer a scripted SPI part expects, and what it answers.

Variants

Write

The driver writes exactly bytes; whatever the part shifts out meanwhile is discarded, as the driver asked.

Fields

bytes: Vec<u8>

The bytes the driver must send.

Read

The driver reads reply.len() bytes and receives reply.

Fields

reply: Vec<u8>

The bytes the part shifts out.

Transfer

The driver writes bytes and receives reply in the same clocks, so the two are the same length.

Fields

bytes: Vec<u8>

The bytes the driver must send.

reply: Vec<u8>

The bytes the part shifts out at the same time.

Fault

The part fails the next transfer with kind.

Fields

kind: ErrorKind

The failure the driver sees.

Implementations

impl SpiStep

pub fn write(bytes: impl Into<Vec<u8>>) -> SpiStep

A write of exactly bytes.

Arguments

• bytes - the bytes the driver must send.

Returns

The step.

pub fn read(reply: impl Into<Vec<u8>>) -> SpiStep

A read answered with reply.

Arguments

• reply - the bytes the part shifts out; the driver must ask for exactly this many.

Returns

The step.

pub fn transfer(bytes: impl Into<Vec<u8>>, reply: impl Into<Vec<u8>>) -> SpiStep

A full-duplex transfer: bytes go out while reply comes in.

Arguments

• bytes - the bytes the driver must send.
• reply - the bytes the part shifts out, as many as bytes.

Returns

The step.

pub fn fault(kind: ErrorKind) -> SpiStep

A transfer that fails with kind.

Arguments

• kind - the failure the driver sees.

Returns

The step.

Trait Implementations

impl Clone for SpiStep

fn clone(&self) -> SpiStep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpiStep

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

Formats the value using the given formatter.

impl Eq for SpiStep

impl PartialEq for SpiStep

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