SpeedArg

Enum SpeedArg 

Source
pub enum SpeedArg {
    Stop,
    EmergencyStop,
    Drive(u8),
}
Expand description

Represents the speed set to a SlotArg.

Variants§

§

Stop

Performs a normal stop. Trains may stop smoothly when they receive a message force them to stop.

§

EmergencyStop

Performs an immediate stop action. Trains do stop immediately.

§

Drive(u8)

Sets the slots speed to a given value. If you want a slot speed to set to 0 use SpeedArg::Stop or create your SpeedArg using SpeedArg::new().

The maximum speed is 126. Higher values may create unexpected behaviour.

Implementations§

Source§

impl SpeedArg

Source

pub fn new(spd: u8) -> Self

Creates a new SpeedArg from the given value. This means returning SpeedArg::Stop if the given spd is set to 0 and returning SpeedArg::Drive with the given spd set as speed otherwise.

§Parameters
  • spd: The speed to create the SpeedArg for. The maximum speed is 126. Higher values may create unexpected behaviour.
Source

pub fn get_spd(&self) -> u8

§Returns

A u8 interpreted value of the given SpeedArg.

Please note that SpeedArg::Stop and SpeedArg::EmergencyStop are both cast to 0 as they both indicates that the slots speed is 0 and only differ in how immediate this state is reached by the connected device.

Trait Implementations§

Source§

impl Clone for SpeedArg

Source§

fn clone(&self) -> SpeedArg

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpeedArg

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for SpeedArg

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SpeedArg

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for SpeedArg

Source§

impl Eq for SpeedArg

Source§

impl StructuralPartialEq for SpeedArg

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.