vfsi-sync 0.1.13

Synchronous scalar and vectorized filesystem interfaces for VFSI
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

//! Synchronous filesystem contracts.
//!
//! Application code uses [`Vfsi`] and [`VfsiExt`]. Backend implementers use
//! [`backend::HandleBackend`] and [`backend::VectorBackend`]; shared defaults
//! live in [`backend::helpers`].

pub use vfsi_core::*;

#[doc(hidden)]
pub mod path {
    pub use vfsi_core::path::*;
}

mod traits;
pub use traits::{BackendDirectoryPage, DirPageCursor, DirectoryPage, ReadAllOptions};
mod application_macros;
mod client;
mod traversal;
pub use client::{FsClient, FsDir, FsRead, FsReadInto, FsWrite, OpenFile};
pub use traversal::walk_events;
/// Native execution contracts for backend implementers and language bindings.
/// Application callers use [`Vfsi`] and [`VfsiExt`].
pub mod backend;

#[cfg(feature = "test-support")]
#[doc(hidden)]
pub mod test_support;

// Preserve backend-facing paths while the canonical portable types live in core.
pub use vfsi_core::api::{
    DEFAULT_DIRECTORY_MAX_ENTRIES, DEFAULT_DIRECTORY_MAX_PATH_BYTES,
    DEFAULT_READ_ALLV_MAX_TOTAL_BYTES, DEFAULT_READ_MAX_BYTES, DEFAULT_READ_STREAM_CHUNK_BYTES,
    DEFAULT_READV_MAX_TOTAL_BYTES, DEFAULT_WALK_MAX_DEPTH, DepthLimit, DirectoryListing,
    ListDirOptions, OpenOptions, ReadIntoResult as FsReadIntoResult, ReadOptions, ResourceLimits,
    StreamCompletion, StreamOptions, TraversalCompletion, WalkControl, WalkEvent, WalkEventKind,
    WriteResult as FsWriteResult,
};

#[doc(hidden)]
pub mod application;

pub use vfsi_core::api::internal::OwnedReadResult as FsReadResult;