Struct plctag_async::AsyncTag

pub struct AsyncTag { /* private fields */ }

tag entry, represents a tag in PLC controller

Implementations

impl AsyncTag

pub async fn create<P: Into<Vec<u8>>>(path: P) -> Result<Self>

create instance of AsyncTag

Tag String Attributes

See https://github.com/libplctag/libplctag/wiki/Tag-String-Attributes for tag string attributes.

pub async fn ready(&mut self) -> Result<()>

wait until created

pub async fn read(&mut self) -> Result<()>

perform read operation.

pub async fn write(&mut self) -> Result<()>

perform write operation

pub fn status(&mut self) -> Status

poll status

pub fn get_attr(
    &mut self,
    attr: impl AsRef<str>,
    default_value: i32
) -> Result<i32>

get tag attribute

pub fn set_attr(&mut self, attr: impl AsRef<str>, value: i32) -> Result<()>

set tag attribute

pub fn elem_size(&mut self) -> Result<i32>

element size

pub fn elem_count(&mut self) -> Result<i32>

element count

pub fn size(&mut self) -> Result<u32>

tag size in bytes

pub fn set_size(&mut self, size: u32) -> Result<u32>

set tag size in bytes, returns old size

pub fn get_bit(&mut self, bit_offset: u32) -> Result<bool>

get bit value

pub fn set_bit(&mut self, bit_offset: u32, value: bool) -> Result<()>

set bit value

pub fn get_value<T: Decode>(&mut self, byte_offset: u32) -> Result<T>

get value from mem, you should call read() before this operation

pub fn get_value_in_place<T: Decode>(
    &mut self,
    byte_offset: u32,
    place: &mut T
) -> Result<()>

get value from mem, you should call read() before this operation

pub fn set_value<T: Encode>(&mut self, byte_offset: u32, value: T) -> Result<()>

set value in mem, you should call write() later

pub async fn read_value<T: Decode>(&mut self, offset: u32) -> Result<T>

perform read & returns the value

pub async fn read_value_in_place<T: Decode>(
    &mut self,
    offset: u32,
    place: &mut T
) -> Result<()>

perform read & returns the value

pub async fn write_value<T: Encode + Send>(
    &mut self,
    offset: u32,
    value: T
) -> Result<()>

set the value and write to PLC Controller

pub fn get_bytes(&mut self, byte_offset: u32, buf: &mut [u8]) -> Result<usize>

get raw bytes

pub fn get_bytes_unchecked(
    &self,
    byte_offset: u32,
    buf: &mut [u8]
) -> Result<usize>

get raw bytes. If buffer length would exceed the end of the data in the tag data buffer, an out of bounds error is returned

pub fn set_bytes(&mut self, byte_offset: u32, buf: &mut [u8]) -> Result<usize>

set raw bytes

pub fn set_bytes_unchecked(
    &mut self,
    byte_offset: u32,
    buf: &[u8]
) -> Result<usize>

set raw bytes. If buffer length would exceed the end of the data in the tag data buffer, an out of bounds error is returned

pub fn into_raw(self) -> RawTag

take the inner

Trait Implementations

impl Debug for AsyncTag

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

Formats the value using the given formatter.