bv-core 0.1.17

Core types for biov: manifests, lockfile, cache layout, and error types
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

use serde::{Deserialize, Serialize};

use crate::error::{BvError, Result};

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[serde(rename_all = "lowercase")]
pub enum PostDownloadAction {
    #[default]
    Noop,
    Extract,
    Decompress,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DataEntry {
    pub id: String,
    pub version: String,
    pub description: Option<String>,
    pub source_urls: Vec<String>,
    /// Expected SHA-256 of the primary downloaded file as `sha256:<hex>`.
    /// Optional: omit when the upstream file is mutable (e.g. NCBI
    /// "current_release" pointers) or when no one has computed a real hash
    /// yet. When set, `bv data fetch` enforces it strictly.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub sha256: Option<String>,
    /// Approximate compressed size in bytes. Optional. Used as a hint for
    /// the progress bar when the server doesn't report Content-Length;
    /// otherwise the server's value wins.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub size_bytes: Option<u64>,
    /// File format hint, e.g. `"tar"`, `"fasta_gz"`, `"raw"`.
    pub format: String,
    #[serde(default)]
    pub post_download_action: PostDownloadAction,
    pub license: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DataManifest {
    pub data: DataEntry,
}

impl DataManifest {
    pub fn from_toml_str(s: &str) -> Result<Self> {
        toml::from_str(s).map_err(|e| BvError::ManifestParse(e.to_string()))
    }
}