Skip to main content

SubInfo

zencan_common::objects

Struct SubInfo

pub struct SubInfo {
    pub size: usize,
    pub data_type: DataType,
    pub access_type: AccessType,
    pub pdo_mapping: PdoMappable,
    pub persist: bool,
}

Expand description

Information about a sub object

Fields§

§size: usize

The size (or max size) of this sub object, in bytes

§data_type: DataType

The data type of this sub object

§access_type: AccessType

Indicates what accesses (i.e. read/write) are allowed on this sub object

§pdo_mapping: PdoMappable

Indicates whether this sub may be mapped to PDOs

§persist: bool

Indicates whether this sub should be persisted when data is saved

Implementations§

impl SubInfo

pub const MAX_SUB_NUMBER: SubInfo

A shorthand value for sub0 on record and array objects

pub const fn new_u32() -> Self

Convenience function for creating a new sub-info by type

pub const fn new_u24() -> Self

Convenience function for creating a new sub-info by type

pub const fn new_u16() -> Self

Convenience function for creating a new sub-info by type

pub const fn new_u8() -> Self

Convenience function for creating a new sub-info by type

pub const fn new_i32() -> Self

Convenience function for creating a new sub-info by type

pub const fn new_i24() -> Self

Convenience function for creating a new sub-info by type

pub const fn new_i16() -> Self

Convenience function for creating a new sub-info by type

pub const fn new_i8() -> Self

Convenience function for creating a new sub-info by type

pub const fn new_f32() -> Self

Convenience function for creating a new sub-info by type

pub const fn new_visibile_str(size: usize) -> Self

Convenience function for creating a new sub-info by type

pub const fn ro_access(self) -> Self

Convenience function to set the access_type to read-only

pub const fn rw_access(self) -> Self

Convenience function to set the access_type to read-write

pub const fn const_access(self) -> Self

Convenience function to set the access_type to const

pub const fn wo_access(self) -> Self

Convenience function to set the access_type to write-only

pub const fn persist(self, value: bool) -> Self

Convenience function to set the persist value

Trait Implementations§

impl Clone for SubInfo

fn clone(&self) -> SubInfo

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for SubInfo

impl Debug for SubInfo

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

Formats the value using the given formatter. Read more

impl Default for SubInfo

fn default() -> SubInfo

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

impl PartialEq for SubInfo

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for SubInfo

Auto Trait Implementations§

impl Freeze for SubInfo

impl RefUnwindSafe for SubInfo

impl Send for SubInfo

impl Sync for SubInfo

impl Unpin for SubInfo

impl UnsafeUnpin for SubInfo

impl UnwindSafe for SubInfo

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.