Struct Register 

pub struct Register {
    pub address: u16,
    pub offset: u8,
    pub width: u8,
    pub read_only: bool,
}

A register, which is some of the bits of a byte at an address.

Fields

address: u16

The byte it lives in.

offset: u8

Which bit of that byte it starts at.

width: u8

How many bits it spans.

read_only: bool

Whether the chip refuses to be written here.

Implementations

impl Register

pub const fn new( address: u16, offset: u8, width: u8, read_only: bool, ) -> Register

Names a register by where it is and how wide it is.

Arguments

• address - the byte it lives in.
• offset - which bit it starts at.
• width - how many bits it spans.
• read_only - whether the chip refuses to be written here.

Returns

The register.

pub const fn is_whole_byte(&self) -> bool

Whether this register is the whole byte rather than a field inside one.

A whole byte is written directly; anything narrower has to be read first, so the bits beside it survive the write.

Returns

Whether a write can skip reading the byte first.

Examples

use pamoja_radios::sx1302::register::{COMMON_VERSION, AGC_MCU_HOST_PROG};

assert!(COMMON_VERSION.is_whole_byte());
assert!(!AGC_MCU_HOST_PROG.is_whole_byte());

pub const fn decode(&self, byte: u8) -> u8

Reads this register out of the byte it shares.

Arguments

• byte - the byte read from address.

Returns

The value, shifted down to where it reads as a number.

pub const fn encode(&self, byte: u8, value: u8) -> u8

Puts a value into this register, leaving the rest of the byte as it was.

Arguments

• byte - the byte as it reads now.
• value - what to put in this register.

Returns

The byte to write back.

Trait Implementations

impl Clone for Register

fn clone(&self) -> Register

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Register

impl Debug for Register

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

Formats the value using the given formatter.

impl Eq for Register

impl PartialEq for Register

fn eq(&self, other: &Register) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Register