Struct CreateGroupMsg

pub struct CreateGroupMsg {
    pub header: Option<Header>,
    pub frq_divider: u32,
    pub alias: String,
    pub paths: Vec<String>,
}

Request to create a publisher group.

User’s request to start publishing specified parameters. Several users may subscribe to the same group. This mechanism reduces the load on the server and allows more clients to get frequent updates.

User may choose a scale factor for the publishing rate of the group.

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

StatusCode::OK - operation successful.

StatusCode::FAILED - operation failed.

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

StatusCode::FAILED_TO_SET_REQUESTED_FRQ - operation successful, but failed to change publisher’s frequency, because the group has already existed.

StatusCode::FAILED_TO_DECODE - failed to decode request message.

StatusCode::SUB_LIST_IS_FULL - failed to subscribe for a parameter, because subscription list is full. Create new parameter group.

StatusCode::WRONG_PARAMETER_PATH - failed to find parameter, because requested path is wrong.

StatusCode::GROUP_LIST_IS_FULL - failed to create new group, because the group list is full. Release at least one group.

Fields

header: Option<Header>

Frame counter and actual time.

frq_divider: u32

Requested frequency divider, to scale down publisher rate.

alias: String

Name of the group.

paths: Vec<String>

List of the parameters.

Trait Implementations

impl Clone for CreateGroupMsg

fn clone(&self) -> CreateGroupMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateGroupMsg

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

Formats the value using the given formatter.

impl Default for CreateGroupMsg

fn default() -> Self

Returns the “default value” for a type.

impl Hash for CreateGroupMsg

const HASH: u32 = 2_662_013_827u32

impl Message for CreateGroupMsg

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 CreateGroupMsg

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