btrfs-fs 0.13.0

High-level filesystem API on top of btrfs-disk: lookup, readdir, read, xattr.
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

//! High-level filesystem API on top of `btrfs-disk`.
//!
//! [`Filesystem`] exposes the operations a userspace driver needs:
//! `lookup`, `readdir`, `read`, `readlink`, `getattr`, `xattr_get`,
//! `xattr_list`, and `statfs`. Each returns plain `std::io::Result`
//! values and does not depend on any FUSE protocol crate, so the same
//! API drives the [`btrfs-fuse`] mount and any other embedder
//! (offline tools, tests, alternate FUSE bindings).
//!
//! # Inode model
//!
//! [`Inode`] is the pair `(subvol, ino)`. For now only the default
//! subvolume is exposed, but multi-subvolume support is the next phase
//! and the API is shaped for it from the start. Callers that need a
//! flat `u64` (e.g. FUSE) translate at the boundary.
//!
//! # Status
//!
//! Read-only. Write support is planned via the `btrfs-transaction`
//! crate; see the project roadmap.
//!
//! [`btrfs-fuse`]: https://docs.rs/btrfs-fuse

#![warn(clippy::pedantic)]
#![allow(
    clippy::missing_errors_doc,
    clippy::missing_panics_doc,
    clippy::module_name_repetitions
)]

mod cache;
mod filesystem;
mod read;
mod xattr;

pub mod dir;
pub mod stat;

pub use btrfs_disk::{
    items::{DeviceItem, RootRef},
    superblock::Superblock,
};
pub use cache::{CacheConfig, CacheStats, LruTreeBlockCache};
pub use dir::{Entry, FileKind};
pub use filesystem::{
    Filesystem, Inode, SearchFilter, SearchItem, SeekHoleData, StatFs,
    SubvolId, SubvolInfo,
};
pub use stat::Stat;
pub use uuid::Uuid;