iceoryx2-bb-elementary 0.3.0

iceoryx2: [internal] elementary constructs that have no dependencies at all
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

// Copyright (c) 2023 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Represents a normal non-null pointer. It was introduced to distinguish normal pointers from
//! [`crate::relocatable_ptr::RelocatablePointer`]. It implements the [`PointerTrait`].

use std::alloc::Layout;
use std::alloc::{alloc, dealloc};

use crate::pointer_trait::PointerTrait;

/// Representation of a pointer which owns its memory.
#[repr(C)]
#[derive(Debug)]
pub struct OwningPointer<T> {
    ptr: *mut T,
    layout: Layout,
}

impl<T> OwningPointer<T> {
    /// Allocates memory for T and number_of_elements. If the number_of_elements is zero it still
    /// allocates memory for one element.
    pub fn new_with_alloc(mut number_of_elements: usize) -> OwningPointer<T> {
        if number_of_elements == 0 {
            number_of_elements = 1;
        }

        let layout = unsafe {
            Layout::from_size_align_unchecked(
                std::mem::size_of::<T>() * number_of_elements,
                std::mem::align_of::<T>(),
            )
        };

        Self {
            ptr: unsafe { alloc(layout) as *mut T },
            layout,
        }
    }
}

impl<T> Drop for OwningPointer<T> {
    fn drop(&mut self) {
        unsafe { dealloc(self.ptr as *mut u8, self.layout) }
    }
}

impl<T> PointerTrait<T> for OwningPointer<T> {
    unsafe fn as_ptr(&self) -> *const T {
        self.ptr as *const T
    }

    unsafe fn as_mut_ptr(&mut self) -> *mut T {
        self.ptr
    }
}