liboxen 0.50.1

Oxen is a fast, unstructured data version control, to help version large machine learning datasets written in Rust.
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

pub mod merkle_hash;
pub mod merkle_reader;
pub mod merkle_transport;
pub mod merkle_writer;
pub mod node;
pub mod node_type;

use std::fmt::Debug;

pub use crate::model::merkle_tree::merkle_hash::MerkleHash;
pub use crate::model::merkle_tree::merkle_reader::MerkleReader;
pub use crate::model::merkle_tree::merkle_transport::{
    MerklePacker, MerkleTransport, MerkleUnpacker, PackOptions, UnpackOptions,
};
pub use crate::model::merkle_tree::merkle_writer::MerkleWriter;
pub use crate::model::merkle_tree::node::merkle_tree_node_cache;
pub use crate::model::merkle_tree::node_type::{
    MerkleTreeNodeIdType, MerkleTreeNodeType, TMerkleTreeNode,
};

/// A complete Merkle tree store supports reading and writing.
///
/// Object-safe via the dyn-compatible [`MerkleReader`] and [`MerkleWriter`].
/// Both sides return [`OxenError`] at the trait surface, so callers can use `?`
/// anywhere they're already returning `Result<_, OxenError>`.
///
/// [`OxenError`]: crate::error::OxenError
pub trait MerkleStore: MerkleReader + MerkleWriter {}

/// Any type that implements both the Merkle reading and writing traits is
/// automatically a [`MerkleStore`]. The `?Sized` bound lets the marker apply
/// to `dyn MerkleStore` itself.
impl<T: MerkleReader + MerkleWriter + ?Sized> MerkleStore for T {}

/// A [`MerkleStore`] that can also pack and unpack Merkle tree nodes for transport.
pub trait TransportableMerkleStore: MerkleStore + MerkleTransport + Debug {}

/// Any type that is a [`MerkleStore`] and a [`MerkleTransport`] is automatically a
/// [`TransportableMerkleStore`]. The `?Sized` bound lets the marker apply to
/// `dyn TransportableMerkleStore` itself. [`Debug`] is required since this is
/// used in [`LocalRepository`] and that struct has a [`Debug`] derive.
impl<T: MerkleStore + MerkleTransport + ?Sized + Debug> TransportableMerkleStore for T {}