iceoryx2-cal 0.9.0

iceoryx2: [internal] high-level traits and implementations that represents OS primitives in an exchangeable fashion
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
86
87
88
89
90
91
92
93
94
95
96

// 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

use core::fmt::Debug;

pub type SegmentIdUnderlyingType = u8;

/// Defines the [`SegmentId`] of a [`SharedMemory`](crate::shared_memory::SharedMemory)
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SegmentId(SegmentIdUnderlyingType);

impl SegmentId {
    /// Creates a new [`SegmentId`] from a given value.
    pub const fn new(value: SegmentIdUnderlyingType) -> Self {
        Self(value)
    }

    /// Returns the underlying value of the [`SegmentId`]
    pub const fn value(&self) -> SegmentIdUnderlyingType {
        self.0
    }

    /// Returns the maximum value the [`SegmentId`] supports.
    pub const fn max_segment_id() -> SegmentIdUnderlyingType {
        SegmentIdUnderlyingType::MAX
    }
}

/// An offset to a [`SharedMemory`](crate::shared_memory::SharedMemory) address. It requires the
///
/// [`SharedMemory::payload_start_address()`](crate::shared_memory::SharedMemory::payload_start_address())
/// of the corresponding [`SharedMemory`](crate::shared_memory::SharedMemory) to be converted into
/// an actual pointer.
///
/// Contains the offset and the corresponding [`SegmentId`].
#[derive(Clone, Copy, Eq, PartialEq)]
pub struct PointerOffset(u64);

impl PointerOffset {
    /// Creates a new [`PointerOffset`] from the given offset value with the [`SegmentId`] == 0.
    pub const fn new(offset: usize) -> PointerOffset {
        const SEGMENT_ID: u8 = 0;
        Self::from_offset_and_segment_id(offset, SegmentId::new(SEGMENT_ID))
    }

    /// Creates a new [`PointerOffset`] from an offset and a [`SegmentId`]
    pub const fn from_offset_and_segment_id(offset: usize, segment_id: SegmentId) -> PointerOffset {
        Self(((offset as u64) << (SegmentIdUnderlyingType::BITS)) | segment_id.value() as u64)
    }

    /// Creates a new [`PointerOffset`] from a provided raw value.
    pub const fn from_value(value: u64) -> PointerOffset {
        Self(value)
    }

    /// Returns the underlying raw value of the [`PointerOffset`]
    pub const fn as_value(&self) -> u64 {
        self.0
    }

    /// Sets the [`SegmentId`] of the [`PointerOffset`].
    pub fn set_segment_id(&mut self, value: SegmentId) {
        self.0 &= !((1u64 << SegmentIdUnderlyingType::BITS) - 1);
        self.0 |= value.0 as u64;
    }

    /// Returns the offset.
    pub const fn offset(&self) -> usize {
        (self.0 >> (SegmentIdUnderlyingType::BITS)) as usize
    }

    /// Returns the [`SegmentId`].
    pub const fn segment_id(&self) -> SegmentId {
        SegmentId((self.0 & ((1u64 << SegmentIdUnderlyingType::BITS) - 1)) as u8)
    }
}

impl Debug for PointerOffset {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(
            f,
            "PointerOffset {{ offset: {}, segment_id: {:?} }}",
            self.offset(),
            self.segment_id()
        )
    }
}