mountos-native 0.2.0

Client for the mountOS native filesystem API
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

//! Blocking client for the mountOS native filesystem API over a Unix socket.
//!
//! ```no_run
//! let c = mountos_native::Client::connect("/home/me/.mountOS/sockets/mountos_api_0123456789abcdef.sock")?;
//! let f = c.open("/a.txt", mountos_native::open_flag::READ_ONLY, 0)?;
//! let data = f.read_at(0, 4096)?;
//! # Ok::<(), mountos_native::Error>(())
//! ```
//!
//! The server pushes notices (warm results, watch changes, closing) on the connection that made
//! the call. A reader thread per connection receives them, and `Client::add_listener` hands every
//! event to your listeners in order. `Client::wait_warm` and `Client::watch` build on the same
//! events. With no listener, events go to the logger in `Options`, or to stderr.

mod bulk;
mod client;
mod dir;
mod error;
mod events;
mod file;
pub mod frame;
mod ops_gen;
mod socket;
mod walk;
mod watch;
pub mod wire;

pub use bulk::StatResult;
pub use client::{Client, ClientOptions, Options, DEFAULT_MAX_INFLIGHT};
pub use dir::Dir;
pub use error::{Error, Result};
pub use events::{ChangeKind, Event, EventKind, ListenerId, Logger};
pub use file::{File, WriteItem};
pub use socket::socket_path;
pub use walk::{DEFAULT_MAX_DIR_ENTRIES, DEFAULT_MAX_WALK_PENDING};
pub use watch::Watch;
pub use wire::{open_flag, DirEntry, FileInfo, FileType, Range, StatfsInfo};