Enum cyphal::Priority

pub enum Priority {
    Exceptional = 0,
    Immediate = 1,
    Fast = 2,
    High = 3,
    Nominal = 4,
    Low = 5,
    Slow = 6,
    Optional = 7,
}

The priority level of a transmission

Variants

Exceptional = 0

Exceptional is the highest priority level and should only be sent when a total system failure has occurred.

Immediate = 1

Immediate is a high priority message.

Fast = 2

Fast is high priority messages but have looser latency requirements than Immediate messages.

High = 3

High priority messages are more important than Nominal messages but have looser latency requirements than Fast messages.

Nominal = 4

This is what all messages should use by default. Specifically the heartbeat messages should use this priority.

Low = 5

Low priority messages are expected to be sent on a bus under all conditions but cannot prevent the delivery of nominal messages.

Slow = 6

Slow messages are low priority messages that have no time sensitivity at all.

Optional = 7

These messages might never be sent (theoretically) for some possible system states.

Trait Implementations

impl Clone for Priority

fn clone(&self) -> Priority

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Priority

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

Formats the value using the given formatter.

impl From<Priority> for u8

fn from(priority: Priority) -> Self

Converts to this type from the input type.

impl Hash for Priority

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 Ord for Priority

fn cmp(&self, other: &Priority) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Priority

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Priority

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

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

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

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

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

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

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

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

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

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

impl TryFrom<u8> for Priority

type Error = CyphalError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> CyphalResult<Self>

Performs the conversion.

impl Copy for Priority

impl Eq for Priority

impl StructuralPartialEq for Priority