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

//! Traits for `opaque_typedef_macros`.
#![warn(missing_docs)]


/// An error type that indicates the error should never happen.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Infallible {}


/// Common functions for opaque typedef-ed sized types.
pub trait OpaqueTypedef: Sized {
    /// Inner type.
    type Inner;
    /// Validation error type.
    type Error;

    /// Creates a new value from the inner value without validation.
    unsafe fn from_inner_unchecked(inner: Self::Inner) -> Self;
    /// Creates a new value from the inner value with validation.
    fn from_inner(inner: Self::Inner) -> Result<Self, Self::Error>;
    /// Takes and returns the inner value with its ownership.
    fn into_inner(self) -> Self::Inner;
    /// Returns the reference to the inner value.
    fn as_inner(&self) -> &Self::Inner;
    /// Returns the mutable reference to the inner value.
    unsafe fn as_inner_mut(&mut self) -> &mut Self::Inner;
}


/// Common functions for opaque typedef-ed unsized types.
pub trait OpaqueTypedefUnsized {
    /// Inner type.
    type Inner: ?Sized;
    /// Validation error type.
    type Error;

    /// Creates a reference from the inner reference without validation.
    unsafe fn from_inner_unchecked(inner: &Self::Inner) -> &Self;
    /// Creates a mutable reference from the inner mutable reference without validation.
    unsafe fn from_inner_unchecked_mut(inner: &mut Self::Inner) -> &mut Self;
    /// Creates a reference from the inner reference with validation.
    fn from_inner(inner: &Self::Inner) -> Result<&Self, Self::Error>;
    /// Creates a mutable reference from the inner mutable reference with validation.
    fn from_inner_mut(inner: &mut Self::Inner) -> Result<&mut Self, Self::Error>;
    /// Returns the inner reference.
    fn as_inner(&self) -> &Self::Inner;
    /// Returns the inner mutable reference.
    unsafe fn as_inner_mut(&mut self) -> &mut Self::Inner;
}