shared-data 0.0.2

A library for data structures living in shared memory.
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

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

use crate::ObjectOffset;
use crate::ObjectSize;
use crate::ShmemId;
use num_traits::FromPrimitive;
use num_traits::ToPrimitive;

#[cfg(feature = "no-panic")]
use no_panic::no_panic;

/// A range of addresses in shared memory, packed into 64 bits.
#[derive(Clone, Copy, Eq, Debug, PartialEq)]
pub struct SharedAddressRange {
    shmem_id: ShmemId,
    shmem_size: ObjectSize,
    object_offset: ObjectOffset,
    object_size: ObjectSize,
}

impl SharedAddressRange {
    #[cfg_attr(feature = "no-panic", no_panic)]
    pub(crate) fn new(
        shmem_id: ShmemId,
        shmem_size: ObjectSize,
        object_offset: ObjectOffset,
        object_size: ObjectSize,
    ) -> SharedAddressRange {
        SharedAddressRange {
            shmem_id,
            shmem_size,
            object_offset,
            object_size,
        }
    }

    #[cfg_attr(feature = "no-panic", no_panic)]
    pub fn null() -> SharedAddressRange {
        SharedAddressRange::from(0)
    }

    #[cfg_attr(feature = "no-panic", no_panic)]
    pub(crate) fn shmem_id(self) -> ShmemId {
        self.shmem_id
    }

    #[cfg_attr(feature = "no-panic", no_panic)]
    pub(crate) fn object_size(&self) -> ObjectSize {
        self.object_size
    }

    #[cfg_attr(feature = "no-panic", no_panic)]
    pub(crate) fn object_offset(&self) -> ObjectOffset {
        self.object_offset
    }

    #[cfg_attr(feature = "no-panic", no_panic)]
    pub(crate) fn object_end(&self) -> Option<ObjectOffset> {
        ObjectOffset::from_u64(
            self.object_offset
                .to_u64()?
                .checked_add(self.object_size.to_u64()?)?,
        )
    }
}