Skip to main content

S3Object

Enum S3Object 

Source
pub enum S3Object {
    NotVersioning(Object),
    Versioning(ObjectVersion),
    DeleteMarker(DeleteMarkerEntry),
}
Expand description

S3 object representation used throughout the deletion pipeline.

Adapted from s3sync’s S3syncObject enum, representing the different kinds of objects that can be listed from S3.

§Variants

  • NotVersioning — An object from a non-versioned bucket (or current version from a versioned bucket listed without version info).
  • Versioning — A specific version of an object in a versioned bucket.
  • DeleteMarker — A delete marker in a versioned bucket (size is always 0).

§Constructors

Use S3Object::new and S3Object::new_versioned to create instances without importing AWS SDK types directly:

use s3rm_rs::S3Object;

let obj = S3Object::new("my-key", 1024);
assert_eq!(obj.key(), "my-key");
assert_eq!(obj.size(), 1024);

Variants§

§

NotVersioning(Object)

An object from a non-versioned bucket.

§

Versioning(ObjectVersion)

A specific version of an object in a versioned bucket.

§

DeleteMarker(DeleteMarkerEntry)

A delete marker in a versioned bucket (size is always 0).

Implementations§

Source§

impl S3Object

Source

pub fn new(key: &str, size: i64) -> Self

Create a non-versioned S3 object with the given key and size in bytes.

The last_modified timestamp defaults to the Unix epoch. This constructor is useful for testing filter callbacks without importing AWS SDK types.

§Examples
use s3rm_rs::S3Object;

let obj = S3Object::new("photos/cat.jpg", 2048);
assert_eq!(obj.key(), "photos/cat.jpg");
assert_eq!(obj.size(), 2048);
assert!(obj.version_id().is_none());
Source

pub fn new_versioned(key: &str, version_id: &str, size: i64) -> Self

Create a versioned S3 object with the given key, version ID, and size in bytes.

The last_modified timestamp defaults to the Unix epoch, and is_latest is set to true. This constructor is useful for testing filter callbacks on versioned objects without importing AWS SDK types.

§Examples
use s3rm_rs::S3Object;

let obj = S3Object::new_versioned("logs/app.log", "v1", 512);
assert_eq!(obj.key(), "logs/app.log");
assert_eq!(obj.version_id(), Some("v1"));
assert_eq!(obj.size(), 512);
Source

pub fn key(&self) -> &str

Source

pub fn last_modified(&self) -> &DateTime

Source

pub fn size(&self) -> i64

Source

pub fn version_id(&self) -> Option<&str>

Source

pub fn e_tag(&self) -> Option<&str>

Source

pub fn is_latest(&self) -> bool

Source

pub fn is_delete_marker(&self) -> bool

Trait Implementations§

Source§

impl Clone for S3Object

Source§

fn clone(&self) -> S3Object

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for S3Object

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for S3Object

Source§

fn eq(&self, other: &S3Object) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for S3Object

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> MaybeSend for T
where T: Send,