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
#[cfg(feature = "sync")]
#[cfg_attr(docsrs, doc(cfg(feature = "sync")))]
mod sync_impl;
#[cfg(feature = "sync")]
#[cfg_attr(docsrs, doc(cfg(feature = "sync")))]
pub use sync_impl::{MmapFileWriter, MmapFileWriterExt};
cfg_async! {
macro_rules! declare_and_impl_basic_writer {
() => {
pin_project! {
/// AsyncMmapFileWriter helps read or write data from mmap file
/// like a normal file.
///
/// # Notes
/// If you use a writer to write data to mmap, there is no guarantee all
/// data will be durably stored. So you need to call [`flush`]/[`flush_range`]/[`flush_async`]/[`flush_async_range`] in [`AsyncMmapFileMutExt`]
/// to guarantee all data will be durably stored.
///
/// [`flush`]: trait.AsyncMmapFileMutExt.html#methods.flush
/// [`flush_range`]: trait.AsyncMmapFileMutExt.html#methods.flush_range
/// [`flush_async`]: trait.AsyncMmapFileMutExt.html#methods.flush_async
/// [`flush_async_range`]: trait.AsyncMmapFileMutExt.html#methods.flush_async_range
/// [`AsyncMmapFileMutExt`]: trait.AsyncMmapFileMutExt.html
pub struct AsyncMmapFileWriter<'a> {
#[pin]
w: Cursor<&'a mut [u8]>,
offset: usize,
len: usize,
}
}
impl<'a> AsyncMmapFileWriter<'a> {
pub(crate) fn new(w: Cursor<&'a mut [u8]>, offset: usize, len: usize) -> Self {
Self {
w,
offset,
len
}
}
/// Returns the start offset(related to the mmap) of the writer
#[inline]
pub fn offset(&self) -> usize {
self.offset
}
/// Returns the length of the writer
#[inline]
pub fn len(&self) -> usize {
self.len
}
}
impl Debug for AsyncMmapFileWriter<'_> {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("AsyncMmapFileWriter")
.field("offset", &self.offset)
.field("len", &self.len)
.field("writer", &self.w)
.finish()
}
}
};
}
}
#[cfg(feature = "smol")]
#[cfg_attr(docsrs, doc(cfg(feature = "smol")))]
pub mod smol_impl;
#[cfg(feature = "tokio")]
#[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
pub mod tokio_impl;