remi 0.10.3

🐻‍❄️🧶 Asynchronous Rust crate to handle communication between applications and object storage providers
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

// 🐻‍❄️🧶 remi-rs: Asynchronous Rust crate to handle communication between applications and object storage providers
// Copyright (c) 2022-2025 Noelware, LLC. <team@noelware.org>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

use bytes::Bytes;
use std::{collections::HashMap, fmt::Display};

/// Represents a file or directory from any storage service.
#[derive(Debug, Clone)]
pub enum Blob {
    /// Represents a directory that was located somewhere.
    Directory(Directory),

    /// Representation of a [`Blob`] that is a file.
    File(File),
}

/// Representation of a [`Blob`] that is a file.
#[derive(Debug, Clone)]
pub struct File {
    /// Returns a `u128` of when this file was last modified, in milliseconds
    /// from January 1st, 1970.
    pub last_modified_at: Option<u128>,

    /// Returns the `Content-Type` header of this file, which should represent
    /// what type of file this is.
    pub content_type: Option<String>,

    /// Returns a `u128` of when this file was last created, in milliseconds
    /// from January 1st, 1970.
    pub created_at: Option<u128>,

    /// Mapping of a file's metadata that the file can retrieve and be used for
    /// external applications.
    pub metadata: HashMap<String, String>,

    /// Whether or not if this file was a symlink or not. This is only used
    /// in the filesystem crate of remi.
    pub is_symlink: bool,

    /// Given [`Bytes`] container that is the actual data in the file.
    pub data: Bytes,

    /// File name
    pub name: String,

    /// File path, usually `{service}://{full filepath}`
    pub path: String,

    /// file length (in bytes)
    pub size: usize,
}

impl Display for File {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        // file "file:///assets/openapi.json" (12345 bytes) | application/json; charset=utf-8
        write!(f, "file [{}] ({} bytes)", self.path, self.size)?;
        if let Some(ref ct) = self.content_type {
            write!(f, " | {ct}")?;
        }

        Ok(())
    }
}

/// Represents a directory that was located somewhere.
#[derive(Debug, Clone)]
pub struct Directory {
    /// Returns a `u128` of when this directory was last created, in milliseconds
    /// from January 1st, 1970.
    pub created_at: Option<u128>,

    /// Directory name
    pub name: String,

    /// Directory path, usually `{service}://{full filepath}`
    pub path: String,
}

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