Enum RobotName

#[repr(u8)]
pub enum RobotName {
    Pierre = 0,
    Prince = 1,
    Patric = 2,
    Stella = 3,
    Stevie = 4,
    Speers = 5,
}

Represents a unique robot, either a physical device or a simulation

Robot names are six letters, where the first letter indicates its type:

• names beginning with ‘S’ are simulated robots, not real
• names beginning with ‘P’ are raspberry pi pico boards

See NUM_ROBOT_NAMES for the number of names

usize values should be consecutive such that an array like [(); NUM_ROBOT_NAMES] can be indexed like arr[robot_name as usize]

However, while they are set at compile time, these values are not stable over the development of the codebase; code should not, for example, specifically rely on Stella as index 0

Variants

Pierre = 0

Prince = 1

Patric = 2

Stella = 3

Stevie = 4

Speers = 5

Implementations

impl RobotName

pub const fn get_all() -> [RobotName; 6]

All robot names in order

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

pub fn is_simulated(&self) -> bool

Whether this robot is managed by the simulator

pub fn is_pico(&self) -> bool

Whether this robot is a raspberry pi pico

pub fn mac_address(&self) -> [u8; 6]

The mac address of this robot, must be unique

Simulated robots look like 02:00:00:00::00:xx

pub fn from_mac_address(address: &[u8; 6]) -> Option<Self>

Uniquely determine the robot name from the mac address, if recognized

Simulated robots look like 02:00:00:00::00:xx

pub fn default_ip(&self) -> [u8; 4]

The default pre-filled ip - robots need not necessarily use this ip

pub fn port(&self) -> u16

The port this robot will listen on for TCP connections

Physical robots may listen on the same port

pub fn robot(&self) -> RobotDefinition<3>

The characteristics of this robot

Trait Implementations

impl Clone for RobotName

fn clone(&self) -> RobotName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RobotName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RobotName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RobotName

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

Formats the value using the given formatter.

impl From<usize> for RobotName

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Ord for RobotName

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

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

fn partial_cmp(&self, other: &RobotName) -> 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 Serialize for RobotName

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for RobotName

impl Eq for RobotName

impl StructuralPartialEq for RobotName