dope-core 0.11.0

The manifold runtime
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use std::cell::Cell;
use std::ptr::NonNull;
use std::slice;

use crate::driver::buffers::ProvidedBuffers;
use crate::driver::{DriverContext, DriverRef};

pub struct ProvidedLease<'d> {
    driver: DriverRef<'d>,
    bid: Cell<Option<u16>>,
    ptr: NonNull<u8>,
    len: usize,
}

pub struct ProvidedView<'d> {
    _lease: ProvidedLease<'d>,
    ptr: NonNull<u8>,
    len: usize,
}

impl<'d> ProvidedLease<'d> {
    /// # Safety
    /// `bid` and the region must name one live unique completion buffer.
    pub(crate) unsafe fn from_raw_completion(
        driver: DriverRef<'d>,
        bid: u16,
        ptr: NonNull<u8>,
        len: usize,
    ) -> Self {
        Self {
            driver,
            bid: Cell::new(Some(bid)),
            ptr,
            len,
        }
    }

    pub fn as_slice(&self) -> &[u8] {
        unsafe { slice::from_raw_parts(self.ptr.as_ptr(), self.len) }
    }

    pub fn range_of(&self, bytes: &[u8]) -> Option<(usize, usize)> {
        let base = self.ptr.as_ptr().addr();
        let start = bytes.as_ptr().addr();
        let offset = start.checked_sub(base)?;
        (offset <= self.len && bytes.len() <= self.len - offset).then_some((offset, bytes.len()))
    }

    pub fn into_view(self, offset: usize, len: usize) -> Result<ProvidedView<'d>, Self> {
        if offset > self.len || len > self.len - offset {
            return Err(self);
        }
        let ptr = unsafe { NonNull::new_unchecked(self.ptr.as_ptr().add(offset)) };
        Ok(ProvidedView {
            _lease: self,
            ptr,
            len,
        })
    }

    pub fn release(&self, driver: &mut DriverContext<'_, 'd>) {
        let _ = self.driver;
        if let Some(bid) = self.bid.take() {
            unsafe { driver.release(bid) };
        }
    }
}

impl AsRef<[u8]> for ProvidedLease<'_> {
    fn as_ref(&self) -> &[u8] {
        self.as_slice()
    }
}

impl Drop for ProvidedLease<'_> {
    fn drop(&mut self) {
        if let Some(bid) = self.bid.take() {
            self.driver.return_buffer(bid);
        }
    }
}

impl ProvidedView<'_> {
    pub fn as_slice(&self) -> &[u8] {
        unsafe { slice::from_raw_parts(self.ptr.as_ptr(), self.len) }
    }

    pub fn len(&self) -> usize {
        self.len
    }

    pub fn is_empty(&self) -> bool {
        self.len == 0
    }

    pub fn advance(&mut self, count: usize) {
        assert!(
            count <= self.len,
            "dope: provided view advance out of bounds"
        );
        self.ptr = unsafe { NonNull::new_unchecked(self.ptr.as_ptr().add(count)) };
        self.len -= count;
    }
}

impl AsRef<[u8]> for ProvidedView<'_> {
    fn as_ref(&self) -> &[u8] {
        self.as_slice()
    }
}