Struct GetParameterMsg

pub struct GetParameterMsg {
    pub header: Option<Header>,
    pub path: String,
}

Request to get a parameter info and its value.

Server’s reply: ParameterMsg, with following status codes:

StatusCode::OK - operation successful,

StatusCode::FAILED - operation failed.

StatusCode::PERMISSION_DENIED - Permission denied because user has no access rights.

StatusCode::FAILED_TO_DECODE - failed to decode request message.

Fields

header: Option<Header>

Frame counter and actual time.

path: String

Path of the requested parameter.

Trait Implementations

impl Clone for GetParameterMsg

fn clone(&self) -> GetParameterMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetParameterMsg

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

Formats the value using the given formatter.

impl Default for GetParameterMsg

fn default() -> Self

Returns the “default value” for a type.

impl Hash for GetParameterMsg

const HASH: u32 = 2_556_374_063u32

impl Message for GetParameterMsg

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 GetParameterMsg

fn eq(&self, other: &GetParameterMsg) -> 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 GetParameterMsg