Enum I2cStep 

pub enum I2cStep {
    Write {
        address: u8,
        bytes: Vec<u8>,
    },
    Read {
        address: u8,
        reply: Vec<u8>,
    },
    WriteRead {
        address: u8,
        bytes: Vec<u8>,
        reply: Vec<u8>,
    },
    Fault {
        address: u8,
        kind: ErrorKind,
    },
}

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

Variants

Write

The driver writes exactly bytes to address.

Fields

address: u8

The 7-bit address the write must go to.

bytes: Vec<u8>

The bytes the driver must send.

Read

The driver reads from address and receives reply, whose length is the length it must ask for.

Fields

address: u8

The 7-bit address the read must come from.

reply: Vec<u8>

The bytes the part answers with.

WriteRead

The driver writes bytes then reads reply.len() bytes from address in one transaction, the shape of a register read.

Fields

address: u8

The 7-bit address of the part.

bytes: Vec<u8>

The bytes the driver must send first, usually a register address.

reply: Vec<u8>

The bytes the part answers with.

Fault

The part fails the next transfer to address with kind, the way a missing or busy part does.

Fields

address: u8

The 7-bit address the failing transfer must go to.

kind: ErrorKind

The failure the driver sees.

Implementations

impl I2cStep

pub fn write(address: u8, bytes: impl Into<Vec<u8>>) -> I2cStep

A write of exactly bytes to address.

Arguments

• address - the 7-bit address.
• bytes - the bytes the driver must send.

Returns

The step.

pub fn read(address: u8, reply: impl Into<Vec<u8>>) -> I2cStep

A read from address answered with reply.

Arguments

• address - the 7-bit address.
• reply - the bytes the part answers with; the driver must ask for exactly this many.

Returns

The step.

pub fn write_read( address: u8, bytes: impl Into<Vec<u8>>, reply: impl Into<Vec<u8>>, ) -> I2cStep

A write of bytes followed by a read answered with reply, in one transaction.

Arguments

• address - the 7-bit address.
• bytes - the bytes the driver must send first.
• reply - the bytes the part answers with.

Returns

The step.

pub fn fault(address: u8, kind: ErrorKind) -> I2cStep

A transfer to address that fails with kind.

Arguments

• address - the 7-bit address.
• kind - the failure the driver sees.

Returns

The step.

Trait Implementations

impl Clone for I2cStep

fn clone(&self) -> I2cStep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for I2cStep

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

Formats the value using the given formatter.

impl Eq for I2cStep

impl PartialEq for I2cStep

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