Struct OverwriteParameterMsg

pub struct OverwriteParameterMsg {
    pub header: Option<Header>,
    pub offset: Option<ParameterOffset>,
    pub activate: bool,
    pub path: String,
    pub value: Vec<u8>,
}

Request to overwrite/force a parameter value.

User’s request to force a parameter value. For the Input and Parameter types the input value will be overwritten, for the Output type, the output value will be overwritten.

By enabling flag ‘activate’, overwrite value will be active until the flag is disabled, by ether commanding ReleaseParameterMsg or OverwriteParameterMsg with ‘activate’ - false.

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

StatusCode::OK - operation successful,

StatusCode::FAILED - operation failed.

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

StatusCode::USER_LOGGED_IN_NO_CONTROL - User is in read-only mode.

StatusCode::WRONG_PARAMETER_PATH - Wrong parameter path.

StatusCode::FAILED_TO_DECODE - failed to decode request message.

Fields

header: Option<Header>

Frame counter and actual time.

offset: Option<ParameterOffset>

Offset of the parameter value.

activate: bool

Flag to enable/disable permanent overwrite.

path: String

Path of the requested parameter.

value: Vec<u8>

New values.

Trait Implementations

impl Clone for OverwriteParameterMsg

fn clone(&self) -> OverwriteParameterMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverwriteParameterMsg

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

Formats the value using the given formatter.

impl Default for OverwriteParameterMsg

fn default() -> Self

Returns the “default value” for a type.

impl Hash for OverwriteParameterMsg

const HASH: u32 = 2_555_401_319u32

impl Message for OverwriteParameterMsg

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 OverwriteParameterMsg

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