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
102
103
104
105
106
107
108
109
110
111
112
113
114
115

// 🐻‍❄️🧶 remi-rs: Robust, and simple asynchronous Rust crate to handle storage-related communications with different storage providers
// Copyright (c) 2022-2023 Noelware <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.

//! # 🐻‍❄️🧶 remi_core
//! **remi_core** is the base API implementation that is used by the remi_* crates available to you. This should be only
//! included in your project if you are creating your own implementation of the [`StorageService`] trait.
//!
//! ## Example
//! ```no_run
//! use emi_core::{StorageService, EmptyConfig};
//! use async_trait::async_trait;
//!
//! struct MyStorageService;
//!
//! #[async_trait]
//! impl StorageService<EmptyConfig> for MyStorageService {
//!     /* omitted details */
//! }
//! ```

use std::{io::Result, path::Path};

pub use async_trait::async_trait;
use bytes::Bytes;

mod blob;
mod builders;

pub use blob::*;
pub use builders::*;

/// `StorageService` is the base primitive for implementing a storage backend. This is the main trait
/// you should implement if you're creating your own storage backend with **remi-rs**. Please refer to the
/// crate documentation for an example on how to implement your own.
#[async_trait]
pub trait StorageService: Send {
    /// The name of this [`StorageService`].
    fn name(self) -> &'static str;

    /// Initializes this [`StorageService`] if it requires initialization or not.
    async fn init(&self) -> Result<()> {
        Ok(())
    }

    /// Opens the file in the given path and returns a Result of the given inner data of the file, if it exists. If the
    /// result was `Ok`, then the inner type will be the [`Bytes`] that the file is contained, or a `Option::None` variant
    /// which can happen if:
    ///
    /// - the path is a directory
    /// - the path doesn't exist.
    async fn open(&self, path: impl AsRef<Path> + Send) -> Result<Option<Bytes>>;

    /// Returns the [`Blob`] if the given path exists on the disk or on the cloud storage provider.
    ///
    /// ```no_run
    /// # use remi::filesystem::FilesystemStorageService;
    /// #
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// #   let service = FilesystemStorageService::new("./.data");
    /// #   service.init().await?;
    /// #
    /// service.blob("./path");
    /// // => Ok(Some(...))
    /// # }
    /// ```
    async fn blob(&self, path: impl AsRef<Path> + Send) -> Result<Option<Blob>>;

    /// Returns a vector of blobs based upon a given path or options request.
    ///
    /// ```no_run
    /// # use remi::filesystem::FilesystemStorageService;
    /// #
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// #   let service = FilesystemStorageService::new("./.data");
    /// #   service.init().await?;
    /// #
    /// service.blobs(None, None);
    /// // => Ok(vec![Blob {}, Blob{}])
    /// # }
    /// ```
    async fn blobs(
        &self,
        path: Option<impl AsRef<Path> + Send>,
        options: Option<ListBlobsRequest>,
    ) -> Result<Vec<Blob>>;

    /// Deletes a given file or directory.
    async fn delete(&self, path: impl AsRef<Path> + Send) -> Result<()>;

    /// Checks if a file exists or not.
    async fn exists(&self, path: impl AsRef<Path> + Send) -> Result<bool>;

    /// Uploads a file to a path with the given [`UploadRequest`].
    async fn upload(&self, path: impl AsRef<Path> + Send, options: UploadRequest) -> Result<()>;
}