Struct NullTermByteField 

pub struct NullTermByteField<const N: usize>(/* private fields */);

A byte field which supports storing short values using null termination to indicate size

This is here to support VisibleString and UnicodeString types.

Implementations

impl<const N: usize> NullTermByteField<N>

pub const fn new(value: [u8; N]) -> Self

Create a new NullTermByteField with the provided value

pub fn len(&self) -> usize

Return the size of the sub object

pub fn load(&self) -> [u8; N]

Atomically load the value stored in the object

Note that this will return the entire array, including any invalid bytes after the null terminator.

pub fn store(&self, value: [u8; N])

Atomically store a new value to the object

pub fn set_str(&self, value: &[u8]) -> Result<(), AbortCode>

Store a str to the object

If the string is shorter than the object size, it will be stored with a null terminator If longer, an error will be returned.

Trait Implementations

impl<const N: usize> Default for NullTermByteField<N>

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> SubObjectAccess for NullTermByteField<N>

fn read(&self, offset: usize, buf: &mut [u8]) -> Result<usize, AbortCode>

Read data from the sub object

fn read_size(&self) -> usize

Return the amount of data which can be read

fn write(&self, data: &[u8]) -> Result<(), AbortCode>

Write data to the sub object

fn begin_partial(&self) -> Result<(), AbortCode>

Begin a multi-part write to the object

fn write_partial(&self, data: &[u8]) -> Result<(), AbortCode>

Write part of multi-part data to the object

fn end_partial(&self) -> Result<(), AbortCode>

Finish a multi-part write