Skip to main content

ObjectDictionary

Struct ObjectDictionary 

Source
pub struct ObjectDictionary<const N: usize> { /* private fields */ }
Expand description

An object dictionary holding up to N entries, addressed by (index, subindex).

Implementations§

Source§

impl<const N: usize> ObjectDictionary<N>

Source

pub const fn new() -> Self

Create an empty object dictionary.

Source

pub fn insert(&mut self, addr: Address, entry: Entry) -> Result<()>

Insert or replace the entry at addr.

Returns Error::DictionaryFull when capacity N is exhausted.

Source

pub fn entry(&self, addr: Address) -> Option<&Entry>

Borrow the raw entry at addr, ignoring access rights.

Source

pub fn read(&self, addr: Address) -> Result<Value>

Read the value at addr, honouring access rights.

Returns Error::ObjectNotFound if absent, or Error::WriteOnly if the object is not readable.

Source

pub fn write(&mut self, addr: Address, value: Value) -> Result<()>

Write value at addr, honouring access rights and the object’s data type.

Returns Error::ObjectNotFound if absent, Error::ReadOnly if not writable, or Error::TypeMismatch if value’s type differs from the stored object’s type.

Source

pub fn set(&mut self, addr: Address, value: Value) -> Result<()>

Set the value at addr from the device side, ignoring master access rights — those govern SDO access, not the application, so this can update a master-read-only object (e.g. publish process data into a TPDO source, or the node’s error register 0x1001). The object must exist and the value’s type must match.

Returns Error::ObjectNotFound if absent or Error::TypeMismatch on a type mismatch.

Trait Implementations§

Source§

impl<const N: usize> Debug for ObjectDictionary<N>

Source§

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

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

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

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<const N: usize> Freeze for ObjectDictionary<N>

§

impl<const N: usize> RefUnwindSafe for ObjectDictionary<N>

§

impl<const N: usize> Send for ObjectDictionary<N>

§

impl<const N: usize> Sync for ObjectDictionary<N>

§

impl<const N: usize> Unpin for ObjectDictionary<N>

§

impl<const N: usize> UnsafeUnpin for ObjectDictionary<N>

§

impl<const N: usize> UnwindSafe for ObjectDictionary<N>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.