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
118
119
120
121
122
123
124
125
126
127
128
129

use crate::Owns;
use core::{
    alloc::{AllocErr, AllocInit, AllocRef, Layout, MemoryBlock, ReallocPlacement},
    ptr::NonNull,
};

/// An emphatically empty implementation of `AllocRef`.
///
/// Although it has no direct use, it is useful as a "terminator" in composite allocators.
///
/// # Examples
///
/// The `Null` will always return `Err`:
///
/// ```rust
/// #![feature(allocator_api)]
///
/// use alloc_compose::Null;
/// use std::alloc::{AllocInit, AllocRef, Global, Layout};
///
/// let memory = Null.alloc(Layout::new::<u32>(), AllocInit::Uninitialized);
/// assert!(memory.is_err())
/// ```
///
/// Even if a zero-sized allocation is requested:
///
/// ```rust
/// # #![feature(allocator_api)]
/// # use alloc_compose::Null;
/// # use std::alloc::{AllocInit, AllocRef, Global, Layout};
/// let memory = Null.alloc(Layout::new::<()>(), AllocInit::Uninitialized);
/// assert!(memory.is_err())
/// ```
#[derive(Debug, Copy, Clone)]
pub struct Null;

unsafe impl AllocRef for Null {
    /// Will always return `Err(AllocErr)`.
    fn alloc(&mut self, _layout: Layout, _init: AllocInit) -> Result<MemoryBlock, AllocErr> {
        Err(AllocErr)
    }

    /// Must not be called, as `alloc` always fails.
    unsafe fn dealloc(&mut self, _ptr: NonNull<u8>, _layout: Layout) {
        unreachable!("NullAlloc::dealloc must never be called as `alloc` always fails")
    }

    /// Must not be called, as `alloc` always fails.
    unsafe fn grow(
        &mut self,
        _ptr: NonNull<u8>,
        _layout: Layout,
        _new_size: usize,
        _placement: ReallocPlacement,
        _init: AllocInit,
    ) -> Result<MemoryBlock, AllocErr> {
        unreachable!("NullAlloc::grow must never be called as `alloc` always fails")
    }

    /// Must not be called, as `alloc` always fails.
    unsafe fn shrink(
        &mut self,
        _ptr: NonNull<u8>,
        _layout: Layout,
        _new_size: usize,
        _placement: ReallocPlacement,
    ) -> Result<MemoryBlock, AllocErr> {
        unreachable!("NullAlloc::shrink must never be called as `alloc` always fails")
    }
}

impl Owns for Null {
    /// Will always return `false.
    fn owns(&self, _memory: MemoryBlock) -> bool {
        false
    }
}

#[cfg(test)]
mod tests {
    #![allow(clippy::wildcard_imports)]
    use super::*;

    #[test]
    #[should_panic(expected = "unreachable")]
    fn dealloc() {
        unsafe { Null.dealloc(NonNull::dangling(), Layout::new::<()>()) };
    }

    #[test]
    #[should_panic(expected = "unreachable")]
    fn grow() {
        unsafe {
            let _ = Null.grow(
                NonNull::dangling(),
                Layout::new::<()>(),
                0,
                ReallocPlacement::MayMove,
                AllocInit::Uninitialized,
            );
        };
    }

    #[test]
    #[should_panic(expected = "unreachable")]
    fn shrink() {
        unsafe {
            let _ = Null.shrink(
                NonNull::dangling(),
                Layout::new::<()>(),
                0,
                ReallocPlacement::MayMove,
            );
        };
    }

    #[test]
    fn owns() {
        assert!(!Null.owns(MemoryBlock {
            ptr: NonNull::dangling(),
            size: 0
        }));
    }

    #[test]
    fn debug() {
        assert_eq!(format!("{:?}", Null), "Null");
    }
}