Struct BoxID

Source

pub struct BoxID(/* private fields */);

Expand description

Box identifier.

It can’t be larger than BoxID::MAX.

§Assigning and managing identifiers for game board pieces

Each game piece is referred to by it’s unique ID. These IDs are simple integers assigned in consecutive order by scanning board top to bottom, and scanning each row from left to right.

Assigning piece IDs

When editing game boards, these IDs are necessarily transient: they change in the process as pieces are being added or removed. During game solving session, these IDs are fixed - referring to box with ID 1 will always refer to the exact same box. Position of that box may change, but it’s identifier remains constant and attached to it. Same reasoning applies to goals and pushers.

Mirroring, rotating, resizing, or trimming a board can therefore invalidate IDs and every SokobanPlus or SavedGame keyed to that board.

Initial board	Board was edited	Box was moved during game play

§Serde

With the serde feature, this serializes as a bare integer and deserializes through TryFrom, so the BoxID::MAX bound is enforced on the way in. The same applies to GoalID, PusherID and PlusID.

Struct BoxID Copy item path

§Assigning and managing identifiers for game board pieces

§Serde

Implementations§

impl BoxID

pub const MAX: u16

pub fn new(id: u16) -> Result<Self, PieceIdError>

Trait Implementations§

impl Clone for BoxID

fn clone(&self) -> Self

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

impl Copy for BoxID

impl Debug for BoxID

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

impl Default for BoxID

fn default() -> Self

impl<'de> Deserialize<'de> for BoxID

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl Display for BoxID

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

impl Eq for BoxID

impl From<BoxID> for u16

fn from(value: BoxID) -> Self

impl From<BoxID> for usize

fn from(value: BoxID) -> Self

impl From<u8> for BoxID

fn from(id: u8) -> Self

impl Hash for BoxID

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

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

impl Ord for BoxID

fn cmp(&self, other: &Self) -> Ordering

fn max(self, other: Self) -> Selfwhere Self: Sized,

fn min(self, other: Self) -> Selfwhere Self: Sized,

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized,

fn clamp_to<R>(self, range: R) -> Selfwhere Self: Sized, R: ClampBounds<Self>,

impl PartialEq for BoxID

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

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

impl PartialEq<BoxID> for GoalID

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

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

impl PartialEq<GoalID> for BoxID

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

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

impl PartialEq<i8> for BoxID

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

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

impl PartialEq<i16> for BoxID

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

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

impl PartialEq<i32> for BoxID

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

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

impl PartialEq<i64> for BoxID

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

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

impl PartialEq<isize> for BoxID

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

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

impl PartialEq<u8> for BoxID

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

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

impl PartialEq<u16> for BoxID

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

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

impl PartialEq<u32> for BoxID

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

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

impl PartialEq<u64> for BoxID

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

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

impl PartialEq<usize> for BoxID

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

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

impl PartialOrd for BoxID

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

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

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

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

Struct BoxID

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

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

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

fn max(self, other: Self) -> Self
where Self: Sized,

fn min(self, other: Self) -> Self
where Self: Sized,

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

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

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

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

fn conv<T>(self) -> T
where Self: Into<T>,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,