Enum StatusCode

#[repr(i32)]
pub enum StatusCode {
    Ok = 0,
    ReadOnlyMode = 1,
    Failed = 65_280,
    FailedToDecode = 4_096,
    SubListIsFull = 4_352,
    WrongParameterPath = 4_608,
    FailedToSetRequestedFrq = 4_864,
    FailedToOpenFile = 5_120,
    GroupListIsFull = 5_376,
    WrongPassword = 8_448,
    UserNotLoggedIn = 8_704,
    PermissionDenied = 8_960,
}

Return status codes.

Return status codes are included in the reply for every user’s request. Using these codes user can verify if request was successful or there was a failure.

Variants

Ok = 0

Request was processed successfully.

ReadOnlyMode = 1

Login is successful, but user has read-only right.

Failed = 65_280

Generic failure mask.

FailedToDecode = 4_096

Failed to decode request message.

SubListIsFull = 4_352

Failed to subscribe for a parameter, because subscription list is full. Create new parameter group.

WrongParameterPath = 4_608

Failed to find parameter, because requested path is wrong.

FailedToSetRequestedFrq = 4_864

When several clients share the same publisher’s group, original publishing frequency is preserved.

FailedToOpenFile = 5_120

Failed to open/save/load a file.

GroupListIsFull = 5_376

Failed to create new group, because the group list is full. Release at least one group.

WrongPassword = 8_448

Login failed, wrong login or password.

UserNotLoggedIn = 8_704

Operation not permitted, because user is not logged in.

PermissionDenied = 8_960

Permission denied because user has no access rights.

Implementations

impl StatusCode

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of StatusCode.

pub fn from_i32(value: i32) -> Option<StatusCode>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a StatusCode, or None if value is not a valid variant.

impl StatusCode

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for StatusCode

fn clone(&self) -> StatusCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatusCode

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

Formats the value using the given formatter.

impl Default for StatusCode

fn default() -> StatusCode

Returns the “default value” for a type.

impl From<StatusCode> for i32

fn from(value: StatusCode) -> i32

Converts to this type from the input type.

impl Hash for StatusCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Hash for StatusCode

const HASH: u32 = 3_615_877_626u32

impl Ord for StatusCode

fn cmp(&self, other: &StatusCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StatusCode

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

fn partial_cmp(&self, other: &StatusCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for StatusCode

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<StatusCode, UnknownEnumValue>

Performs the conversion.

impl Copy for StatusCode

impl Eq for StatusCode

impl StructuralPartialEq for StatusCode