slatedb-mirror 0.18.1

Local whole-object mirror for an object store.
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

//! A local whole-object mirror for an [`object_store::ObjectStore`].
//!
//! The mirror stores user-defined metadata and object attributes in unencrypted
//! JSON `.meta` files in the local mirror directory. If these values contain
//! sensitive data, protect the directory with access controls and filesystem or
//! disk encryption.
//!
//! See [RFC 0034](https://github.com/slatedb/slatedb/blob/main/rfcs/0034-local-object-mirroring.md).
//!
//! `slatedb-mirror` must not depend on `slatedb`. SlateDB-specific rules live in
//! `slatedb` as a mirror policy.

#![cfg_attr(test, allow(clippy::unwrap_used))]
#![warn(clippy::panic)]
#![cfg_attr(test, allow(clippy::panic))]
// Disallow non-approved non-deterministic types and functions in production code
#![deny(clippy::disallowed_types, clippy::disallowed_methods)]
#![cfg_attr(
    test,
    allow(
        clippy::disallowed_macros,
        clippy::disallowed_types,
        clippy::disallowed_methods
    )
)]

mod download;
pub mod error;
mod handle;
mod inner;
mod layout;
mod mirror;
mod multipart;
mod ordering;
mod policy;
mod retry;
mod scan;
mod startup;

pub use error::MirrorError;
pub use handle::MirrorHandle;
pub use mirror::{
    ObjectStoreMirror, ObjectStoreMirrorBuilder, DEFAULT_DOWNLOAD_CONCURRENCY,
    DEFAULT_REMOTE_SCAN_INTERVAL,
};
pub use policy::{MirrorPolicy, MultipartRoute, ReadRoute, WriteRoute};
pub use slatedb_common::vfs::{StdVfs, Vfs, VfsEntry, VfsLock, VfsWriter};