Enum DoorState 

#[non_exhaustive]
pub enum DoorState {
    Closed,
    Opening {
        ticks_remaining: u32,
        open_duration: u32,
        close_duration: u32,
    },
    Open {
        ticks_remaining: u32,
        close_duration: u32,
    },
    Closing {
        ticks_remaining: u32,
    },
}

State machine for elevator doors.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Closed

Doors are fully closed.

Opening

Doors are in the process of opening.

Fields

ticks_remaining: u32

Ticks left in the opening transition.

open_duration: u32

How many ticks the door stays open once fully opened.

close_duration: u32

How many ticks the closing transition takes.

Open

Doors are fully open and holding.

Fields

ticks_remaining: u32

Ticks left before the doors begin closing.

close_duration: u32

How many ticks the closing transition takes.

Closing

Doors are in the process of closing.

Fields

ticks_remaining: u32

Ticks left in the closing transition.

Implementations

impl DoorState

pub const fn is_open(&self) -> bool

Returns true if the doors are fully open.

pub const fn is_closed(&self) -> bool

Returns true if the doors are fully closed.

pub const fn request_open(transition_ticks: u32, open_ticks: u32) -> Self

Begin opening the door.

pub const fn tick(&mut self) -> DoorTransition

Advance the door state by one tick. Returns the transition that occurred.

Trait Implementations

impl Clone for DoorState

fn clone(&self) -> DoorState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DoorState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DoorState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DoorState

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

Formats the value using the given formatter.

impl PartialEq for DoorState

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

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 DoorState

impl Eq for DoorState

impl StructuralPartialEq for DoorState