Struct clyde_3g_eps_api::StatusCode

pub struct StatusCode { /* fields omitted */ }

EPS Board Status Codes

Methods

impl StatusCode

pub const LAST_COMMAND_FAILED: StatusCode

Last Command Failed

pub const WATCHDOG_ERROR: StatusCode

Watchdog Error

pub const BAD_COMMAND_DATA: StatusCode

Bad Command Data

pub const BAD_COMMAND_CHANNEL: StatusCode

Bad Command Channel

pub const ERROR_READING_EEPROM: StatusCode

Error Reading EEPROM

pub const POWER_ON_RESET: StatusCode

Power On Reset

pub const BROWN_OUT_RESET: StatusCode

Brown Out Reset

pub const fn empty() -> StatusCode

Returns an empty set of flags

pub const fn all() -> StatusCode

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<StatusCode>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> StatusCode

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u8) -> StatusCode

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: StatusCode) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: StatusCode) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: StatusCode)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: StatusCode)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: StatusCode)

Toggles the specified flags in-place.

pub fn set(&mut self, other: StatusCode, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl StatusCode

pub fn to_vec(self) -> Vec<String>

Convert the flags byte into a vector containing the string representations of all flags present.

Examples

use eps_api::EpsResult;
use clyde_3g_eps_api::*;

let flags = StatusCode::BAD_COMMAND_DATA | StatusCode::POWER_ON_RESET;

let conv = flags.to_vec();

assert_eq!(conv, vec!["BAD_COMMAND_DATA", "POWER_ON_RESET"]);

Trait Implementations

impl Eq for StatusCode

impl Default for StatusCode

fn default() -> StatusCode

Returns the "default value" for a type.

impl Clone for StatusCode

fn clone(&self) -> StatusCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<StatusCode> 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: &StatusCode) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Extend<StatusCode> for StatusCode

fn extend<T: IntoIterator<Item = StatusCode>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl PartialEq<StatusCode> for StatusCode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Copy for StatusCode

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, 

Feeds a slice of this type into the given [Hasher].

impl Sub<StatusCode> for StatusCode

type Output = StatusCode

The resulting type after applying the - operator.

fn sub(self, other: StatusCode) -> StatusCode

Returns the set difference of the two sets of flags.

impl SubAssign<StatusCode> for StatusCode

fn sub_assign(&mut self, other: StatusCode)

Disables all flags enabled in the set.

impl Not for StatusCode

type Output = StatusCode

The resulting type after applying the ! operator.

fn not(self) -> StatusCode

Returns the complement of this set of flags.

impl BitAnd<StatusCode> for StatusCode

type Output = StatusCode

The resulting type after applying the & operator.

fn bitand(self, other: StatusCode) -> StatusCode

Returns the intersection between the two sets of flags.

impl BitOr<StatusCode> for StatusCode

type Output = StatusCode

The resulting type after applying the | operator.

fn bitor(self, other: StatusCode) -> StatusCode

Returns the union of the two sets of flags.

impl BitXor<StatusCode> for StatusCode

type Output = StatusCode

The resulting type after applying the ^ operator.

fn bitxor(self, other: StatusCode) -> StatusCode

Returns the left flags, but with all the right flags toggled.

impl BitAndAssign<StatusCode> for StatusCode

fn bitand_assign(&mut self, other: StatusCode)

Disables all flags disabled in the set.

impl BitOrAssign<StatusCode> for StatusCode

fn bitor_assign(&mut self, other: StatusCode)

Adds the set of flags.

impl BitXorAssign<StatusCode> for StatusCode

fn bitxor_assign(&mut self, other: StatusCode)

Toggles the set of flags.

impl Debug for StatusCode

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

Formats the value using the given formatter.

impl FromIterator<StatusCode> for StatusCode

fn from_iter<T: IntoIterator<Item = StatusCode>>(iterator: T) -> StatusCode

Creates a value from an iterator.

impl Octal for StatusCode

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

Formats the value using the given formatter.

impl Binary for StatusCode

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

Formats the value using the given formatter.

impl LowerHex for StatusCode

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

Formats the value using the given formatter.

impl UpperHex for StatusCode

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

Formats the value using the given formatter.