winsafe 0.0.27

Windows API and GUI in safe, idiomatic Rust.
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

use crate::decl::*;
use crate::guard::*;
use crate::prelude::*;

/// RAII implementation for [`HVERSIONINFO`](crate::HVERSIONINFO) which releases
/// the underlying memory block when the object goes out of scope.
pub struct VersionInfoGuard {
	handle: HVERSIONINFO,
}

impl Drop for VersionInfoGuard {
	fn drop(&mut self) {
		if let Some(h) = self.handle.as_opt() {
			let hglobal_ptr = unsafe { HGLOBAL::from_ptr(h.ptr()) };
			let _ = unsafe { GlobalFreeGuard::new(hglobal_ptr) };
		}
	}
}

impl std::ops::Deref for VersionInfoGuard {
	type Target = HVERSIONINFO;

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

impl std::ops::DerefMut for VersionInfoGuard {
	fn deref_mut(&mut self) -> &mut Self::Target {
		&mut self.handle
	}
}

impl VersionInfoGuard {
	/// Constructs the guard by taking ownership of the handle.
	///
	/// # Safety
	///
	/// Be sure the handle is a valid [`HGLOBAL`](crate::HGLOBAL) memory block.
	#[must_use]
	pub const unsafe fn new(handle: HVERSIONINFO) -> Self {
		Self { handle }
	}

	/// Ejects the underlying handle, leaving a
	/// [`Handle::INVALID`](crate::prelude::Handle::INVALID) in its
	/// place.
	///
	/// Since the internal handle will be invalidated, the destructor will not
	/// run. It's your responsability to run it, otherwise you'll cause a memory
	/// leak.
	#[must_use]
	pub fn leak(&mut self) -> HVERSIONINFO {
		std::mem::replace(&mut self.handle, Handle::INVALID)
	}
}