win64 0.0.25

Hand-crafted, idiomatic Rust wrappers for Win32
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

pub mod experimental {
  use std::sync::Arc;

  pub type Handle<T> = Arc<T>;

  pub enum Handle1<T> {
    Valid(T),
    Invalid,
  }
}

pub trait Handle {
  /// # Safety
  /// Reading directly from raw pointers should be handled carefully and validation performed.
  ///
  unsafe fn from_raw(raw: usize) -> Self;
  /// # Safety
  /// Reading directly from raw pointers should be handled carefully and validation performed.
  ///
  unsafe fn from_ptr(raw: *mut std::ffi::c_void) -> Self;

  fn to_raw(self) -> usize;
  fn to_ptr(self) -> *mut std::ffi::c_void;
}

// Adapted from ash https://docs.rs/ash/latest/src/ash/vk/macros.rs.html#121-162
#[macro_export]
macro_rules! declare_handle {
  ($name: ident, &, &) => {
    $crate::declare_handle_struct!($name, $alias, $doc_link);
    $crate::declare_handle_body!($name);
  };
  ($name: ident, $alias: meta, &) => {
    $crate::declare_handle_struct!($name, $alias, doc = "");
    $crate::declare_handle_body!($name);
  };
  ($name: ident, &, $doc_link: meta) => {
    $crate::declare_handle_struct!($name, &, $doc_link);
    $crate::declare_handle_body!($name);
  };
  ($name: ident, $alias: meta, $doc_link: meta) => {
    $crate::declare_handle_struct!($name, $alias, $doc_link);
    $crate::declare_handle_body!($name);
  };
}

#[macro_export]
macro_rules! declare_handle_struct {
  ($name: ident, &, &) => {
    declare_handle_struct!($name, &, doc = "");
  };
  ($name: ident, $alias: meta, &) => {
    declare_handle_struct!($name, $alias, doc = "");
  };
  ($name: ident, &, $doc_link: meta) => {
    #[repr(transparent)]
    #[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Hash)]
    #[$doc_link]
    pub struct $name(*mut ());
  };
  ($name: ident, $alias: meta, $doc_link: meta) => {
    #[repr(transparent)]
    #[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Hash)]
    #[doc($alias)]
    #[$doc_link]
    pub struct $name(*mut ());
  };
}

#[macro_export]
macro_rules! declare_handle_body {
  ($name: ident) => {
    impl Default for $name {
      fn default() -> Self {
        Self::null()
      }
    }
    impl $crate::core::Handle for $name {
      unsafe fn from_raw(raw: usize) -> Self {
        Self(raw as _)
      }

      unsafe fn from_ptr(raw: *mut std::ffi::c_void) -> Self {
        Self(raw.cast())
      }

      fn to_raw(self) -> usize {
        self.0 as _
      }

      fn to_ptr(self) -> *mut std::ffi::c_void {
        self.0.cast()
      }
    }
    unsafe impl Send for $name {}
    unsafe impl Sync for $name {}
    impl $name {
      pub const fn null() -> Self {
        Self(std::ptr::null_mut())
      }

      pub const fn is_null(&self) -> bool {
        self.0.is_null()
      }
    }
    impl std::fmt::Pointer for $name {
      fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Pointer::fmt(&self.0, f)
      }
    }
    impl std::fmt::Debug for $name {
      fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Debug::fmt(&(self.0 as usize), f)
      }
    }
  };
}