Struct S3SnapshotStore 

pub struct S3SnapshotStore { /* private fields */ }

Bytes live in an opendal-managed S3 bucket under {prefix}/group-{gid}/.

Implementations

impl S3SnapshotStore

pub fn new(operator: Operator, prefix: impl Into<String>) -> Self

pub fn memory_for_tests( prefix: impl Into<String>, ) -> Result<Self, SnapshotStoreError>

In-memory opendal operator under prefix, for tests.

pub fn s3_from_env() -> Result<Self, SnapshotStoreError>

Build an S3 operator from the cold-store URSULA_COLD_S3_* env. Snapshot blobs share the cold bucket/credentials and use URSULA_SNAPSHOT_S3_PREFIX (defaults to snapshots) for separation.

Trait Implementations

impl Debug for S3SnapshotStore

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

Formats the value using the given formatter.

impl SnapshotStore for S3SnapshotStore

fn upload<'a>( &'a self, key: SnapshotKey, bytes: Vec<u8>, ) -> SnapshotStoreFuture<'a, SnapshotLocation>

Persist a snapshot blob and return its location. Stores own naming and MAY ignore parts of key (Inline does).

fn download<'a>( &'a self, location: &'a SnapshotLocation, ) -> SnapshotStoreFuture<'a, Vec<u8>>

Retrieve a snapshot blob given its location.

fn delete<'a>( &'a self, location: &'a SnapshotLocation, ) -> SnapshotStoreFuture<'a, ()>

Best-effort delete; missing is not an error.

fn verify_uploaded<'a>( &'a self, location: &'a SnapshotLocation, ) -> SnapshotStoreFuture<'a, ()>

Verify that a freshly-uploaded snapshot is actually retrievable from the backend. Called immediately after upload returns Ok, before the new pointer is published. Catches silent partial-success modes (multipart upload Init/Part Ok but Complete failed, opendal retry returning Ok on cached state, etc.) that would otherwise leave current_snapshot pointing at a 404. Default no-op for backends that can’t lie about persistence (Inline keeps bytes in the pointer; Local uses a single fs syscall whose Ok means present). The S3 backend overrides this with a stat round-trip.

fn health_check(&self) -> SnapshotStoreFuture<'_, ()>

Lightweight liveness probe for the backend, used by the snapshot driver to detect local S3 loss WITHOUT triggering a build_snapshot (whose failure openraft treats as fatal). The default is “always healthy”: in-memory and local-filesystem backends cannot be remotely unavailable. The S3 backend overrides this with a cheap stat.