cluFullTransmute 1.4.2

Extended, no-constraint type transmutation API, featuring safe checks and const-ready logic.
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

//! A handy trait for converting any `T` to the desired `To` without directly calling
//! crate functions.

use crate::TransmuteErr;

pub trait ToTransmute
where
	Self: Sized,
{
	/// A constant function reinterprets the bits of a value of one type as another type.
	///
	/// # Safety
	///
	/// If the sizes do not match, a panic arises.
	#[cfg_attr(docsrs, doc(cfg(feature = "try_transmute")))]
	#[cfg(any(test, feature = "try_transmute"))]
	unsafe fn try_transmute_or_panic<To>(self) -> To;

	/// A constant function reinterprets the bits of a value of one type as another type.
	///
	/// # Safety
	///
	/// If the size does not match, an error occurs.
	#[cfg_attr(docsrs, doc(cfg(feature = "try_transmute")))]
	#[cfg(any(test, feature = "try_transmute"))]
	unsafe fn try_transmute<To>(self) -> Result<To, TransmuteErr<Self>>;

	/// Reinterprets the bits of a value of one type as another type.
	/// The function is completely const, data dimensions are not checked.
	///
	/// # Safety
	/// No protections.
	unsafe fn transmute_unchecked<To>(self) -> To;
}

impl<T> ToTransmute for T
where
	T: Sized,
{
	/// A constant function reinterprets the bits of a value of one type as another type.
	///
	/// # Safety
	///
	/// If the sizes do not match, a panic arises.
	#[cfg_attr(docsrs, doc(cfg(feature = "try_transmute")))]
	#[cfg(any(test, feature = "try_transmute"))]
	#[cfg_attr(
		all(feature = "transmute-inline", not(feature = "transmute-inline-always")),
		inline
	)]
	#[cfg_attr(feature = "transmute-inline-always", inline(always))]
	unsafe fn try_transmute_or_panic<To>(self) -> To {
		unsafe { crate::try_transmute_or_panic(self) }
	}

	/// A constant function reinterprets the bits of a value of one type as another type.
	///
	/// # Safety
	///
	/// If the size does not match, an error occurs.
	#[cfg_attr(docsrs, doc(cfg(feature = "try_transmute")))]
	#[cfg(any(test, feature = "try_transmute"))]
	#[cfg_attr(
		all(feature = "transmute-inline", not(feature = "transmute-inline-always")),
		inline
	)]
	#[cfg_attr(feature = "transmute-inline-always", inline(always))]
	unsafe fn try_transmute<To>(self) -> Result<To, TransmuteErr<Self>> {
		unsafe { crate::try_transmute(self) }
	}

	/// Reinterprets the bits of a value of one type as another type.
	/// The function is completely const, data dimensions are not checked.
	///
	/// # Safety
	/// No protections.
	#[cfg_attr(
		all(feature = "transmute-inline", not(feature = "transmute-inline-always")),
		inline
	)]
	#[cfg_attr(feature = "transmute-inline-always", inline(always))]
	unsafe fn transmute_unchecked<To>(self) -> To {
		unsafe { crate::raw::transmute_unchecked(self) }
	}
}