liboxen 0.50.0

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

//! Enumeration of supported Oxen Versions
//!

use std::fmt::Display;
use std::str::FromStr;

use crate::{error::OxenError, util::oxen_version::OxenVersion};

#[derive(Debug, Clone)]
pub enum MinOxenVersion {
    V0_10_0,
    V0_19_0,
    V0_25_0,
    LATEST,
}

impl MinOxenVersion {
    /// Should default to latest if none is supplied in most cases
    pub fn or_latest(s: Option<String>) -> Result<MinOxenVersion, OxenError> {
        if let Some(version) = s {
            MinOxenVersion::from_string(version)
        } else {
            Ok(MinOxenVersion::LATEST)
        }
    }

    /// Only use this if we have no version specified in an .oxen/config.toml file
    pub fn or_earliest(s: Option<String>) -> Result<MinOxenVersion, OxenError> {
        if let Some(version) = s {
            MinOxenVersion::from_string(version)
        } else {
            Ok(MinOxenVersion::V0_10_0)
        }
    }

    pub fn from_string(s: impl AsRef<str>) -> Result<MinOxenVersion, OxenError> {
        match s.as_ref() {
            "0.10.0" => Ok(MinOxenVersion::V0_10_0),
            "0.19.0" => Ok(MinOxenVersion::V0_19_0),
            "0.25.0" => Ok(MinOxenVersion::V0_25_0),
            "0.36.0" => Ok(MinOxenVersion::LATEST),
            _ => Err(OxenError::invalid_version(s.as_ref())),
        }
    }

    pub fn as_str(&self) -> &'static str {
        match self {
            MinOxenVersion::V0_10_0 => "0.10.0",
            MinOxenVersion::V0_19_0 => "0.19.0",
            MinOxenVersion::V0_25_0 => "0.25.0",
            MinOxenVersion::LATEST => "0.36.0",
        }
    }

    pub fn to_oxen_version(&self) -> OxenVersion {
        let v = self.as_str();
        OxenVersion::from_str(v).unwrap_or_else(|_| panic!("Invalid version string: {v}"))
    }
}

impl Display for MinOxenVersion {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

impl Eq for MinOxenVersion {}
impl PartialEq for MinOxenVersion {
    fn eq(&self, other: &Self) -> bool {
        self.to_oxen_version() == other.to_oxen_version()
    }
}

impl PartialOrd for MinOxenVersion {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for MinOxenVersion {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.to_oxen_version().cmp(&other.to_oxen_version())
    }
}