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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use std::path::Path;

use crate::config::repository_config::MerkleStoreKind;
use crate::core::versions::MinOxenVersion;
use crate::error::OxenError;
use crate::model::LocalRepository;
use crate::storage::StorageConfig;
use crate::util;

pub fn init(path: &Path) -> Result<LocalRepository, OxenError> {
    let hidden_dir = util::fs::oxen_hidden_dir(path);
    if hidden_dir.exists() {
        return Err(OxenError::RepoAlreadyExistsAtPath(path.to_path_buf()));
    }

    // Cleanup the .oxen dir if init fails
    match init_with_version_default(path, MinOxenVersion::LATEST, false) {
        Ok(result) => Ok(result),
        Err(error) => {
            util::fs::remove_dir_all(hidden_dir)?;
            Err(error)
        }
    }
}

// default storage backend is local
pub fn init_with_version_default(
    path: &Path,
    version: MinOxenVersion,
    is_vfs: bool,
) -> Result<LocalRepository, OxenError> {
    init_with_version_and_merkle_store(path, version, is_vfs, MerkleStoreKind::default())
}

/// Sync init variant that lets the caller pick the [`MerkleStoreKind`].
pub fn init_with_version_and_merkle_store(
    path: &Path,
    version: MinOxenVersion,
    is_vfs: bool,
    merkle_store_kind: MerkleStoreKind,
) -> Result<LocalRepository, OxenError> {
    let hidden_dir = util::fs::oxen_hidden_dir(path);

    util::fs::create_dir_all(hidden_dir)?;
    if util::fs::config_filepath(path).try_exists()? {
        return Err(OxenError::RepoAlreadyExistsAtPath(path.to_path_buf()));
    }

    let repo = LocalRepository::new_from_version_with_merkle_store_kind(
        path,
        version.to_string(),
        None,
        is_vfs,
        merkle_store_kind,
    )?;
    repo.save()?;

    Ok(repo)
}

pub async fn init_with_version_and_storage_config(
    path: &Path,
    version: MinOxenVersion,
    storage_config: Option<StorageConfig>,
    is_vfs: bool,
) -> Result<LocalRepository, OxenError> {
    init_with_version_storage_and_merkle_store(
        path,
        version,
        storage_config,
        is_vfs,
        MerkleStoreKind::default(),
    )
    .await
}

/// Async init variant that lets the caller pick both the [`StorageConfig`] and the
/// [`MerkleStoreKind`]. Source of truth for the CLI's `oxen init` plumbing.
pub async fn init_with_version_storage_and_merkle_store(
    path: &Path,
    version: MinOxenVersion,
    storage_config: Option<StorageConfig>,
    is_vfs: bool,
    merkle_store_kind: MerkleStoreKind,
) -> Result<LocalRepository, OxenError> {
    let hidden_dir = util::fs::oxen_hidden_dir(path);

    util::fs::create_dir_all(hidden_dir)?;
    if util::fs::config_filepath(path).try_exists()? {
        return Err(OxenError::RepoAlreadyExistsAtPath(path.to_path_buf()));
    }

    let repo = LocalRepository::new_from_version_with_merkle_store_kind(
        path,
        version.to_string(),
        storage_config,
        is_vfs,
        merkle_store_kind,
    )?;
    repo.save()?;

    let version_store = repo.version_store();
    version_store.init().await?;

    Ok(repo)
}