Skip to main content

CoilPoints

Struct CoilPoints 

Source
pub struct CoilPoints { /* private fields */ }
Expand description

A local cache of coil values mapped to their Modbus addresses.

Use apply_read to merge values returned by ModbusClient::read_coils.

Implementations§

Source§

impl CoilPoints

Source

pub fn new(start_address: u16, count: usize) -> Self

Create a new coil cache with count coils starting at start_address, all initially false.

Source

pub fn from_values(start_address: u16, values: Vec<bool>) -> Self

Create a coil cache from existing values.

Source

pub fn start_address(&self) -> u16

The starting Modbus address of this cache.

Source

pub fn len(&self) -> usize

The number of coils in this cache.

Source

pub fn is_empty(&self) -> bool

Returns true if the cache contains no coils.

Source

pub fn values(&self) -> &[bool]

View the raw coil values as a slice.

Source

pub fn get(&self, address: u16) -> Option<bool>

Get the coil value at the given Modbus address, or None if out of range.

Source

pub fn set(&mut self, address: u16, value: bool) -> Result<(), ClientError>

Set the coil value at the given Modbus address.

Source

pub fn apply_read( &mut self, start_address: u16, values: &[bool], ) -> Result<(), ClientError>

Merge a batch of read values into this cache at the given start address.

Trait Implementations§

Source§

impl Clone for CoilPoints

Source§

fn clone(&self) -> CoilPoints

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CoilPoints

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CoilPoints

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for CoilPoints

Source§

impl StructuralPartialEq for CoilPoints

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more