Enum SceneId 

#[repr(u8)]
pub enum SceneId {
    One = 0,
    Two = 1,
    Three = 2,
    Four = 3,
    Five = 4,
    Six = 5,
    Seven = 6,
    Eight = 7,
    Nine = 8,
    Ten = 9,
    Eleven = 10,
    Twelve = 11,
    Thirteen = 12,
    Fourteen = 13,
    Fifteen = 14,
    Sixteen = 15,
}

Identifier values for Scenes, allowing for panic-free indexing via id* methods.

use ot_tools_io::parts::{SceneXlvAssignments};
use ot_tools_io::identifiers::{SavedState, PartId, SceneId};
use ot_tools_io::BankFile;

// mutable ref so we can demonstrate using `id_mut` methods
let mut bank = BankFile::default();
let part_one_working = bank
    .parts_mut(&SavedState::Working)
    .id_mut(&PartId::One);

// using variant by hand
// -- scene 1 (reference)
part_one_working.scene_xlvs.id_ref(&SceneId::One);
// -- scene 16 (mutable reference)
part_one_working.scene_xlvs.id_mut(&SceneId::Sixteen);

// lookup from an unsigned integer value
// failed conversions return an `OtToolsIoError::InvalidIndex` error for you to handle
// -- scene 1 (reference)
part_one_working.scene_xlvs.id_ref(&SceneId::try_from(0_usize)?);
// -- scene 16 (mutable reference)
part_one_working.scene_xlvs.id_mut(&SceneId::try_from(15_usize)?);

// iterate over variants
for scene_id in SceneId::iter() {
    part_one_working.scene_xlvs.id_ref(&scene_id);
}

Variants

One = 0

Two = 1

Three = 2

Four = 3

Five = 4

Six = 5

Seven = 6

Eight = 7

Nine = 8

Ten = 9

Eleven = 10

Twelve = 11

Thirteen = 12

Fourteen = 13

Fifteen = 14

Sixteen = 15

Implementations

impl SceneId

pub fn as_index(&self) -> usize

Get the identifier variant as a zero-indexed integer for raw array indexing

pub fn iter() -> impl Iterator<Item = Self>

Iterate over all possible enum variants

Trait Implementations

impl Clone for SceneId

fn clone(&self) -> SceneId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SceneId

impl Debug for SceneId

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

Formats the value using the given formatter.

impl Display for SceneId

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

Formats the value using the given formatter.

impl Eq for SceneId

impl Hash for SceneId

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 SceneId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SceneId

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

const CARDINALITY: usize

Number of values of type Self.

fn next(&self) -> Option<Self>

Returns value following *self or None if this was the end.

fn previous(&self) -> Option<Self>

Returns value preceding *self or None if this was the beginning.

fn first() -> Option<Self>

Returns the first value of type Self.

fn last() -> Option<Self>

Returns the last value of type Self.

impl StructuralPartialEq for SceneId

impl TryFrom<&u8> for SceneId

type Error = OtToolsIoError

The type returned in the event of a conversion error.

fn try_from(value: &u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&u16> for SceneId

type Error = OtToolsIoError

The type returned in the event of a conversion error.

fn try_from(value: &u16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&u32> for SceneId

type Error = OtToolsIoError

The type returned in the event of a conversion error.

fn try_from(value: &u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for SceneId

type Error = OtToolsIoError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u16> for SceneId

type Error = OtToolsIoError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for SceneId

type Error = OtToolsIoError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for SceneId

type Error = OtToolsIoError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.