shardline-server-core 1.0.0

Shared core types for the Shardline server ecosystem.
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

//! Server frontend types shared between crate extractions.

use thiserror::Error;

/// Runtime protocol frontend selection.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ServerFrontend {
    /// Validated Xet-compatible CAS frontend.
    Xet,
    /// Git LFS batch and object-transfer frontend.
    Lfs,
    /// Bazel-compatible HTTP remote-cache frontend.
    BazelHttp,
    /// OCI Distribution frontend.
    Oci,
    /// HuggingFace Hub API compatibility frontend.
    Hub,
    /// Prometheus metrics endpoint.
    Metrics,
}

impl ServerFrontend {
    /// Parses a frontend token.
    ///
    /// # Errors
    ///
    /// Returns [`ServerFrontendParseError`] when the token is not a supported
    /// frontend.
    pub fn parse(value: &str) -> Result<Self, ServerFrontendParseError> {
        match value {
            "xet" => Ok(Self::Xet),
            "lfs" => Ok(Self::Lfs),
            "bazel-http" => Ok(Self::BazelHttp),
            "oci" => Ok(Self::Oci),
            "hub" => Ok(Self::Hub),
            "metrics" => Ok(Self::Metrics),
            _ => Err(ServerFrontendParseError),
        }
    }

    /// Returns the canonical frontend token.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Xet => "xet",
            Self::Lfs => "lfs",
            Self::BazelHttp => "bazel-http",
            Self::Oci => "oci",
            Self::Hub => "hub",
            Self::Metrics => "metrics",
        }
    }
}

/// Invalid server frontend token.
#[derive(Debug, Clone, Copy, Error, PartialEq, Eq)]
#[error("invalid server frontend")]
pub struct ServerFrontendParseError;