shared-files 0.2.0

Single writer, multiple reader in-process file sharing
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

//! Contains public traits.

use std::path::PathBuf;
use tokio::io::{AsyncRead, AsyncWrite};

/// Trait for types used as a file storage backend.
#[async_trait::async_trait]
pub trait SharedFileType: AsyncRead + AsyncWrite {
    /// The type created when producing a reader or writer. Typically `Self`.
    type Type;

    /// The error type.
    type OpenError;

    /// The error type.
    type SyncError;

    /// Opens a new [`Type`](Self::Type) instance in read-only mode.
    async fn open_ro(&self) -> Result<Self::Type, Self::OpenError>;

    /// Opens a new [`Type`](Self::Type) instance in read-write mode.
    async fn open_rw(&self) -> Result<Self::Type, Self::OpenError>;

    /// Synchronizes data and metadata with the underlying buffer.
    async fn sync_all(&self) -> Result<(), Self::SyncError>;

    /// Synchronizes data with the underlying buffer.
    async fn sync_data(&self) -> Result<(), Self::SyncError>;
}

/// Trait for types that can be newly constructed asynchronously.
#[async_trait::async_trait]
pub trait AsyncNewFile {
    /// The type created on success.
    type Target;
    /// The error type.
    type Error;

    /// Creates a new instance of the type [`Target`](AsyncNewFile::Target).
    async fn new_async() -> Result<Self::Target, Self::Error>;
}

/// Trait for types that can be newly constructed asynchronously.
pub trait NewFile {
    /// The type created on success.
    type Target;
    /// The error type.
    type Error;

    /// Creates a new instance of the type [`Target`](AsyncNewFile::Target).
    fn new() -> Result<Self::Target, Self::Error>;
}

/// Trait for types that can synchronously determine the file path.
pub trait FilePath {
    /// Obtains the path of the temporary file.
    fn file_path(&self) -> &PathBuf;
}