craydate 0.1.7

A safe Rust API for the Playdate hand held gaming system.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use core::ptr::NonNull;

use super::bitmap::BitmapRef;
use crate::ctypes::*;

/// A `Bitmap` that is not owned by the application, so can only be used as a borrowed `BitmapRef`.
///
/// A `UnownedBitmapRef` can be cloned which is a shallow clone that produces another borrow on the
/// unowned `Bitmap`.
#[derive(Debug)]
pub struct UnownedBitmapRef<'a> {
  bref: BitmapRef,
  _marker: core::marker::PhantomData<&'a u8>,
}

impl UnownedBitmapRef<'_> {
  /// Construct a UnownedBitmapRef from a non-owning pointer.
  ///
  /// Requires being told the lifetime of the Bitmap this is making a reference to.
  pub(crate) fn from_ptr<'a>(bitmap_ptr: NonNull<CBitmap>) -> UnownedBitmapRef<'a> {
    UnownedBitmapRef {
      bref: BitmapRef::from_ptr(bitmap_ptr),
      _marker: core::marker::PhantomData,
    }
  }
}

impl Clone for UnownedBitmapRef<'_> {
  fn clone(&self) -> Self {
    UnownedBitmapRef::from_ptr(self.copy_non_null())
  }
}

impl core::ops::Deref for UnownedBitmapRef<'_> {
  type Target = BitmapRef;

  fn deref(&self) -> &Self::Target {
    &self.bref
  }
}

impl AsRef<BitmapRef> for UnownedBitmapRef<'_> {
  fn as_ref(&self) -> &BitmapRef {
    self // This calls Deref.
  }
}

/// A mutable `Bitmap` that is not owned by the application, so can only be used as a borrowed
/// `BitmapRef`.
///
/// A `UnownedBitmapRef` can be cloned which is a shallow clone that produces access to another
/// mutable borrow on the unowned `Bitmap`.
pub struct UnownedBitmapMut<'a> {
  bref: UnownedBitmapRef<'a>,
}
impl UnownedBitmapMut<'_> {
  /// Construct a UnownedBitmapMut from a non-owning pointer.
  ///
  /// Requires being told the lifetime of the Bitmap this is making a reference to.
  pub(crate) fn from_ptr<'a>(bitmap_ptr: NonNull<CBitmap>) -> UnownedBitmapMut<'a> {
    UnownedBitmapMut {
      bref: UnownedBitmapRef::from_ptr(bitmap_ptr),
    }
  }
}

impl Clone for UnownedBitmapMut<'_> {
  fn clone(&self) -> Self {
    // The clone() has writable access so requires a mutable pointer just as the original does.
    UnownedBitmapMut::from_ptr(self.copy_non_null())
  }
}

impl core::ops::Deref for UnownedBitmapMut<'_> {
  type Target = BitmapRef;

  fn deref(&self) -> &Self::Target {
    &self.bref.bref
  }
}
impl core::ops::DerefMut for UnownedBitmapMut<'_> {
  fn deref_mut(&mut self) -> &mut Self::Target {
    &mut self.bref.bref
  }
}

impl AsRef<BitmapRef> for UnownedBitmapMut<'_> {
  fn as_ref(&self) -> &BitmapRef {
    self // This calls Deref.
  }
}
impl AsMut<BitmapRef> for UnownedBitmapMut<'_> {
  fn as_mut(&mut self) -> &mut BitmapRef {
    self // This calls DerefMut.
  }
}