Struct RegisterOperation

Source

pub struct RegisterOperation<'b, B, RegisterFs, AddressType, Access, Repeat>where
    B: Block,
    B::Interface: RegisterInterfaceBase<AddressType = AddressType>,
    RegisterFs: Fieldset,
    AddressType: Address,
{ /* private fields */ }

Expand description

Object that performs actions on the device in the context of a register

Implementations§

Source §

impl<'b, B, RegisterFs, AddressType, Access, Repeat> RegisterOperation<'b, B, RegisterFs, AddressType, Access, Repeat>
where RegisterFs: Fieldset, B: Block, B::Interface: RegisterInterfaceBase<AddressType = AddressType>, AddressType: Address,

Source

pub fn address(&self) -> AddressType

Get the register’s address.

Source

pub fn reset_value(&self) -> RegisterFs

Get the register’s reset value.

Source

pub fn plan(&self) -> Plan<AddressType, RegisterFs, Access>
where Repeat: NotRepeating,

Get a plan to read, write or modify for bulk register operations

Source

pub fn plan_at( &self, index: Repeat::Index, ) -> Plan<AddressType, RegisterFs, Access>
where Repeat: Repeating,

Get a plan to read, write or modify for bulk register operations at a given index

Source

pub fn plan_with_zero(&self) -> Plan<AddressType, RegisterFs, Access>
where Repeat: NotRepeating, Access: WriteCapability,

Same as Self::plan, but initialize the fieldset with all zeroes

Source

pub fn plan_with_zero_at( &self, index: Repeat::Index, ) -> Plan<AddressType, RegisterFs, Access>
where Repeat: Repeating, Access: WriteCapability,

Same as Self::plan_at, but initialize the fieldset with all zeroes

Source

pub fn plan_array_at<const N: usize>( self, index: Repeat::Index, ) -> Plan<AddressType, [RegisterFs; N], Access>
where Repeat: ArrayRepeating, B::RegisterAddressMode: AddressMode,

Get a plan to read, write or modify an array of registers for bulk register operations with a given start index and length

Source

pub fn plan_array_with_zero_at<const N: usize>( self, index: Repeat::Index, ) -> Plan<AddressType, [RegisterFs; N], Access>
where Repeat: ArrayRepeating, B::RegisterAddressMode: AddressMode, Access: WriteCapability,

Same as Self::plan_array_at, but initialize the fieldsets with all zeroes

Source

pub fn write( self, f: impl FnOnce(&mut RegisterFs), ) -> Result<(), <B::Interface as RegisterInterfaceBase>::Error>
where Repeat: NotRepeating, B::Interface: RegisterInterface, Access: WriteCapability,

Write to the register.

The closure is given the write object initialized to the reset value of the register. If no reset value is specified for this register, this function is the same as Self::write_with_zero.

Source

pub fn write_at( self, index: Repeat::Index, f: impl FnOnce(&mut RegisterFs), ) -> Result<(), <B::Interface as RegisterInterfaceBase>::Error>
where Repeat: Repeating, B::Interface: RegisterInterface, Access: WriteCapability,

Write to the register at a given index.

The closure is given the write object initialized to the reset value of the register. If no reset value is specified for this register, this function is the same as Self::write_with_zero_at.

Source

pub fn write_array_at<const N: usize>( self, index: Repeat::Index, f: impl FnOnce(&mut [RegisterFs; N]), ) -> Result<(), <B::Interface as RegisterInterfaceBase>::Error>
where Repeat: ArrayRepeating, B::Interface: RegisterInterface, B::RegisterAddressMode: AddressMode, Access: WriteCapability,

Write to an array of register at the given index and N length.

The closure is given the write object initialized to the reset value of the register. If no reset value is specified for this register, this function is the same as Self::write_array_with_zero_at.

Source

pub fn write_async( self, f: impl FnOnce(&mut RegisterFs), ) -> impl Future<Output = Result<(), <B::Interface as RegisterInterfaceBase>::Error>>
where Repeat: NotRepeating, B::Interface: AsyncRegisterInterface, Access: WriteCapability,

Write to the register.

The closure is given the write object initialized to the reset value of the register. If no reset value is specified for this register, this function is the same as Self::write_with_zero.

Source

pub fn write_at_async( self, index: Repeat::Index, f: impl FnOnce(&mut RegisterFs), ) -> impl Future<Output = Result<(), <B::Interface as RegisterInterfaceBase>::Error>>
where Repeat: Repeating, B::Interface: AsyncRegisterInterface, Access: WriteCapability,

Write to the register at a given index.

The closure is given the write object initialized to the reset value of the register. If no reset value is specified for this register, this function is the same as Self::write_with_zero_at_async.

Source

pub fn write_array_at_async<const N: usize>( self, index: Repeat::Index, f: impl FnOnce(&mut [RegisterFs; N]), ) -> impl Future<Output = Result<(), <B::Interface as RegisterInterfaceBase>::Error>>
where Repeat: ArrayRepeating, B::Interface: AsyncRegisterInterface, B::RegisterAddressMode: AddressMode, Access: WriteCapability,

Write to an array of register at the given index and N length.

The closure is given the write object initialized to the reset value of the register. If no reset value is specified for this register, this function is the same as Self::write_array_with_zero_at_async.

Source