Struct ParameterInfo

pub struct ParameterInfo {
    pub id: u32,
    pub data_type: u32,
    pub data_size: u32,
    pub number_of_elements: u32,
    pub flags: u32,
    pub permissions: u32,
    pub param_type: i32,
    pub group_id: i32,
    pub unit: i32,
    pub path: String,
}

Parameter information fields.

Active state of the parameter in the tree, including its name, size, data type, io type and active flags.

Fields

id: u32

Unique id, assigned by parameter server.

data_type: u32

Tag of the data type.

data_size: u32

Size of one data element.

number_of_elements: u32

Number of the elements.

flags: u32

Parameter flags (overwrite, link etc…).

permissions: u32

Access permissions.

param_type: i32

I/O type of the parameter.

group_id: i32

Group ID of the owner.

unit: i32

SI unit of the parameter.

path: String

Path (including name) of the parameter.

Implementations

impl ParameterInfo

pub fn param_type(&self) -> ParameterType

Returns the enum value of param_type, or the default if the field is set to an invalid enum value.

pub fn set_param_type(&mut self, value: ParameterType)

Sets param_type to the provided enum value.

pub fn group_id(&self) -> UserGroup

Returns the enum value of group_id, or the default if the field is set to an invalid enum value.

pub fn set_group_id(&mut self, value: UserGroup)

Sets group_id to the provided enum value.

pub fn unit(&self) -> Unit

Returns the enum value of unit, or the default if the field is set to an invalid enum value.

pub fn set_unit(&mut self, value: Unit)

Sets unit to the provided enum value.

Trait Implementations

impl Clone for ParameterInfo

fn clone(&self) -> ParameterInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterInfo

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

Formats the value using the given formatter.

impl Default for ParameterInfo

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ParameterInfo

const HASH: u32 = 1_391_968_952u32

impl Message for ParameterInfo

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ParameterInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ParameterInfo