tape-sdk 0.4.0

High-level SDK for tapedrive blob upload/download operations
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

use tape_core::types::{ContentType, SlotNumber, StorageUnits, TrackNumber};
use tape_crypto::Hash;
use tape_crypto::prelude::Address;

const OBJECT_LIST_PAGE_LIMIT: u32 = 1_000;

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ObjectMeta {
    pub size: u64,
    pub etag: Hash,
    pub content_type: ContentType,
    pub block_time: Option<i64>,
    pub slot: SlotNumber,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ListedObject {
    pub name: Vec<u8>,
    pub size: StorageUnits,
    pub etag: Hash,
    pub block_time: Option<i64>,
    pub slot: SlotNumber,
    pub data_tape: Address,
    pub track_number: TrackNumber,
    pub kind: u64,
    pub content_type: ContentType,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ObjectListPage {
    pub objects: Vec<ListedObject>,
    pub common_prefixes: Vec<Vec<u8>>,
    pub next_cursor: Option<Vec<u8>>,
    pub is_truncated: bool,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ListObjectsQuery {
    pub prefix: Vec<u8>,
    pub delimiter: Option<Vec<u8>>,
    pub cursor: Option<Vec<u8>>,
    pub limit: u32,
}

impl ListObjectsQuery {
    pub fn new(prefix: impl AsRef<[u8]>) -> Self {
        Self {
            prefix: prefix.as_ref().to_vec(),
            ..Self::default()
        }
    }

    pub fn with_delimiter(mut self, delimiter: impl AsRef<[u8]>) -> Self {
        self.delimiter = Some(delimiter.as_ref().to_vec());
        self
    }

    pub fn with_cursor(mut self, cursor: impl Into<Vec<u8>>) -> Self {
        self.cursor = Some(cursor.into());
        self
    }

    pub fn with_limit(mut self, limit: u32) -> Self {
        self.limit = limit;
        self
    }
}

impl Default for ListObjectsQuery {
    fn default() -> Self {
        Self {
            prefix: Vec::new(),
            delimiter: None,
            cursor: None,
            limit: OBJECT_LIST_PAGE_LIMIT,
        }
    }
}

impl From<tape_protocol::api::ObjectListItem> for ListedObject {
    fn from(value: tape_protocol::api::ObjectListItem) -> Self {
        Self {
            name: value.name,
            size: value.size,
            etag: value.etag,
            block_time: value.block_time,
            slot: value.slot,
            data_tape: value.data_tape,
            track_number: value.track_number,
            kind: value.kind,
            content_type: value.content_type,
        }
    }
}