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 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
use async_trait::async_trait;
use auto_impl::auto_impl;
use futures::Stream;
use std::str::FromStr;
use std::{fmt, ops::Range, string::ParseError};
use thiserror::Error;
use time::OffsetDateTime;
use md5::{Digest, Md5};
/// A single element of the [ObjectClient::get_object] response is a pair of offset within the
/// object and the bytes starting at that offset.
pub type GetBodyPart = (u64, Box<[u8]>);
#[derive(Debug, Clone, PartialEq)]
pub struct ETag {
etag: String,
}
impl ETag {
pub fn as_str(&self) -> &str {
&self.etag
}
// Creating default etag for tests
pub fn for_tests() -> Self {
Self {
etag: "test_etag".to_string(),
}
}
// Creating unique etag from bytes
pub fn from_object_bytes(data: &[u8]) -> Self {
let mut hasher = Md5::new();
hasher.update(data);
let hash = hasher.finalize();
let result = format!("{:x}", hash);
Self { etag: result }
}
}
impl FromStr for ETag {
type Err = ParseError;
fn from_str(value: &str) -> Result<Self, Self::Err> {
Ok(ETag {
etag: value.to_string(),
})
}
}
/// An [ObjectClient] is an S3-like blob storage interface
#[async_trait]
#[auto_impl(Arc)]
pub trait ObjectClient {
type GetObjectResult: Stream<Item = ObjectClientResult<GetBodyPart, GetObjectError, Self::ClientError>> + Send;
type ClientError: std::error::Error + Send + Sync + 'static;
/// Delete a single object from the object store.
///
/// DeleteObject will succeed even if the object within the bucket does not exist.
async fn delete_object(
&self,
bucket: &str,
key: &str,
) -> ObjectClientResult<DeleteObjectResult, DeleteObjectError, Self::ClientError>;
/// Get an object from the object store. Returns a stream of body parts of the object. Parts are
/// guaranteed to be returned by the stream in order and contiguously.
async fn get_object(
&self,
bucket: &str,
key: &str,
range: Option<Range<u64>>,
if_match: Option<ETag>,
) -> ObjectClientResult<Self::GetObjectResult, GetObjectError, Self::ClientError>;
/// List the objects in a bucket under a given prefix
async fn list_objects(
&self,
bucket: &str,
continuation_token: Option<&str>,
delimiter: &str,
max_keys: usize,
prefix: &str,
) -> ObjectClientResult<ListObjectsResult, ListObjectsError, Self::ClientError>;
/// Retrieve object metadata without retrieving the object contents
async fn head_object(
&self,
bucket: &str,
key: &str,
) -> ObjectClientResult<HeadObjectResult, HeadObjectError, Self::ClientError>;
/// Put an object into the object store.
/// The contents are provided by the client as an async stream of buffers.
async fn put_object(
&self,
bucket: &str,
key: &str,
params: &PutObjectParams,
contents: impl Stream<Item = impl AsRef<[u8]> + Send> + Send,
) -> ObjectClientResult<PutObjectResult, PutObjectError, Self::ClientError>;
/// Retrieves all the metadata from an object without returning the object contents.
async fn get_object_attributes(
&self,
bucket: &str,
key: &str,
max_parts: Option<usize>,
part_number_marker: Option<usize>,
object_attributes: &[ObjectAttribute],
) -> ObjectClientResult<GetObjectAttributesResult, GetObjectAttributesError, Self::ClientError>;
}
/// Errors returned by calls to an [ObjectClient]. Errors that are explicitly modeled on a
/// per-request-type basis are [ServiceError]s. Other generic or unhandled errors are
/// [ClientError]s.
///
/// The distinction between these two types of error can sometimes be blurry. As a rough heuristic,
/// [ServiceError]s are those that *any reasonable implementation* of an object client would be
/// capable of experiencing, and [ClientError]s are anything else. For example, any object client
/// could experience a "no such key" error, but only object clients that implement a permissions
/// system could experience "permission denied" errors. When in doubt, we err towards *not* adding
/// new [ServiceError]s, as they are public API for *every* object client.
#[derive(Debug, Error)]
pub enum ObjectClientError<S, C> {
/// An error returned by the service itself
#[error("Service error")]
ServiceError(#[source] S),
/// An error within the object client (for example, an unexpected response, or a failure to
/// construct the request).
#[error("Client error")]
ClientError(#[from] C),
}
pub type ObjectClientResult<T, S, C> = Result<T, ObjectClientError<S, C>>;
#[derive(Debug, Error, PartialEq, Eq)]
#[non_exhaustive]
pub enum GetObjectError {
#[error("The bucket does not exist")]
NoSuchBucket,
#[error("The key does not exist")]
NoSuchKey,
#[error("At least one of the preconditions specified did not hold")]
PreconditionFailed,
}
/// Result of a [ObjectClient::list_objects] request
#[derive(Debug)]
#[non_exhaustive]
pub struct ListObjectsResult {
/// The name of the bucket.
pub bucket: String,
/// The list of objects.
pub objects: Vec<ObjectInfo>,
/// The list of common prefixes. This rolls up all of the objects with a common prefix up to
/// the next instance of the delimiter.
pub common_prefixes: Vec<String>,
/// If present, the continuation token to use to query more results.
pub next_continuation_token: Option<String>,
}
#[derive(Debug, Error, PartialEq, Eq)]
#[non_exhaustive]
pub enum ListObjectsError {
#[error("The bucket does not exist")]
NoSuchBucket,
}
/// Result of a [ObjectClient::head_object] request
#[derive(Debug)]
#[non_exhaustive]
pub struct HeadObjectResult {
/// The name of the bcuket
pub bucket: String,
/// Object metadata
pub object: ObjectInfo,
}
#[derive(Debug, Error, PartialEq, Eq)]
#[non_exhaustive]
pub enum HeadObjectError {
/// Note that HeadObject cannot distinguish between NoSuchBucket and NoSuchKey errors
#[error("The object was not found")]
NotFound,
}
/// Result of a [ObjectClient::delete_object] request
///
/// Note: DeleteObject calls on a non-existent object within a bucket are considered a success.
///
/// TODO: Populate this struct with return fields from the S3 API, e.g., version id, delete marker.
#[derive(Debug)]
#[non_exhaustive]
pub struct DeleteObjectResult {}
#[derive(Debug, Error, PartialEq, Eq)]
#[non_exhaustive]
pub enum DeleteObjectError {
#[error("The bucket does not exist")]
NoSuchBucket,
}
/// Result of a [ObjectClient::get_object_attributes] request
#[derive(Debug, Default)]
pub struct GetObjectAttributesResult {
/// ETag of the object
pub etag: Option<String>,
/// Checksum of the object
pub checksum: Option<Checksum>,
/// Object parts metadata for multi part object
pub object_parts: Option<GetObjectAttributesParts>,
/// Storage class of the object
pub storage_class: Option<String>,
/// Object size
pub object_size: Option<u64>,
}
#[derive(Debug, Error, PartialEq, Eq)]
#[non_exhaustive]
pub enum GetObjectAttributesError {
#[error("The bucket does not exist")]
NoSuchBucket,
#[error("The key does not exist")]
NoSuchKey,
}
/// Parameters to a [ObjectClient::put_object] request
/// TODO: Populate this struct with parameters from the S3 API, e.g., storage class, encryption.
#[derive(Debug, Default)]
#[non_exhaustive]
pub struct PutObjectParams {}
/// Result of a [ObjectClient::put_object] request
/// TODO: Populate this struct with return fields from the S3 API, e.g., etag.
#[derive(Debug)]
#[non_exhaustive]
pub struct PutObjectResult {}
#[derive(Debug, Error, PartialEq, Eq)]
#[non_exhaustive]
pub enum PutObjectError {
#[error("The bucket does not exist")]
NoSuchBucket,
}
/// Metadata about a single S3 object.
/// See https://docs.aws.amazon.com/AmazonS3/latest/API/API_Object.html for more details.
#[derive(Debug)]
pub struct ObjectInfo {
/// Key for this object.
pub key: String,
/// Size of this object in bytes.
pub size: u64,
/// The time this object was last modified.
pub last_modified: OffsetDateTime,
/// Storage class for this object. Optional because head_object does not return
/// the storage class in its response. See examples here:
/// https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html#API_HeadObject_Examples
pub storage_class: Option<String>,
/// Entity tag of this object.
pub etag: String,
}
/// All possible object attributes that can be retrived from [ObjectClient::get_object_attributes].
/// Fields that you do not specify are not returned.
#[derive(Debug)]
pub enum ObjectAttribute {
/// ETag of the object
ETag,
/// Checksum of the object
Checksum,
/// Object parts metadata for multi part object
ObjectParts,
/// Storage class of the object
StorageClass,
/// Object size
ObjectSize,
}
impl fmt::Display for ObjectAttribute {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let attr_name = match self {
ObjectAttribute::ETag => "ETag",
ObjectAttribute::Checksum => "Checksum",
ObjectAttribute::ObjectParts => "ObjectParts",
ObjectAttribute::StorageClass => "StorageClass",
ObjectAttribute::ObjectSize => "ObjectSize",
};
write!(f, "{}", attr_name)
}
}
/// Metadata about object checksum.
/// See https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html for more details.
#[derive(Debug)]
pub struct Checksum {
/// Base64-encoded, 32-bit CRC32 checksum of the object
pub checksum_crc32: Option<String>,
/// Base64-encoded, 32-bit CRC32C checksum of the object
pub checksum_crc32c: Option<String>,
/// Base64-encoded, 160-bit SHA-1 digest of the object
pub checksum_sha1: Option<String>,
/// Base64-encoded, 256-bit SHA-256 digest of the object
pub checksum_sha256: Option<String>,
}
/// Metadata about object parts from GetObjectAttributes API.
/// See https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributesParts.html for more details.
#[derive(Debug)]
pub struct GetObjectAttributesParts {
/// Indicates whether the returned list of parts is truncated
pub is_truncated: Option<bool>,
/// Maximum number of parts allowed in the response
pub max_parts: Option<usize>,
/// When a list is truncated, this element specifies the next marker
pub next_part_number_marker: Option<usize>,
/// The marker for the current part
pub part_number_marker: Option<usize>,
/// Array of metadata for particular parts
pub parts: Option<Vec<ObjectPart>>,
/// Total number of parts
pub total_parts_count: Option<usize>,
}
/// Metadata for an individual object part.
/// See https://docs.aws.amazon.com/AmazonS3/latest/API/API_ObjectPart.html for more details.
#[derive(Debug)]
pub struct ObjectPart {
/// Checksum of the object
pub checksum: Option<Checksum>,
/// Number of the part, this value is a positive integer between 1 and 10,000
pub part_number: usize,
// Size of the part in bytes
pub size: usize,
}