Struct GcsBackend 

pub struct GcsBackend { /* private fields */ }

GCS JSON API backend for long-term storage of large objects.

Implementations

impl GcsBackend

pub async fn new( config: GcsConfig, streams: &ChangeStreamFactory, ) -> Result<Self>

Creates an authenticated GCS JSON API backend bound to the bucket in config.

Trait Implementations

impl Backend for GcsBackend

fn name(&self) -> &'static str

The backend name, used for diagnostics.

fn upload_granularity(&self) -> u64

Returns the upload granularity for sessions opened by this backend, in bytes.

fn put_object<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, id: &'life1 ObjectId, metadata: &'life2 Metadata, stream: ClientStream, _access_time: Timestamp, ) -> Pin<Box<dyn Future<Output = Result<PutResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Stores an object at the given path with the given metadata.

fn get_object<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 ObjectId, access_time: Timestamp, range: Option<ByteRange>, ) -> Pin<Box<dyn Future<Output = Result<GetResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieves (part of) an object at the given path, returning its metadata, a description of the part being returned, and the payload.

fn get_metadata<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 ObjectId, access_time: Timestamp, ) -> Pin<Box<dyn Future<Output = Result<MetadataResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieves only the metadata for an object, without the payload.

fn set_expiry<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 ObjectId, target: ExpiryUpdate, access_time: Timestamp, ) -> Pin<Box<dyn Future<Output = Result<SetExpiryResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Extends the deadline of an existing object with expiration policy.

fn delete_object<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 ObjectId, _access_time: Timestamp, ) -> Pin<Box<dyn Future<Output = Result<DeleteResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Deletes the object at the given path.

fn create_upload_session<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, id: &'life1 ObjectId, metadata: &'life2 Metadata, upload_length: NonZeroU64, ) -> Pin<Box<dyn Future<Output = Result<Option<BackendToken>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Creates a resumable upload session for the object at id.

fn put_chunk<'life0, 'life1, 'async_trait>( &'life0 self, session: &'life1 Session, offset: u64, content_length: u64, stream: ClientStream, ) -> Pin<Box<dyn Future<Output = Result<UploadProgress>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Writes a chunk of content_length bytes at offset into an open session.

fn upload_offset<'life0, 'life1, 'async_trait>( &'life0 self, session: &'life1 Session, ) -> Pin<Box<dyn Future<Output = Result<UploadProgress>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Reports how far the session has progressed.

fn cancel_upload<'life0, 'life1, 'async_trait>( &'life0 self, session: &'life1 Session, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Cancels an upload session, discarding whatever was uploaded.

fn join<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Waits for any outstanding background operations to complete before shutdown.

impl Debug for GcsBackend

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

Formats the value using the given formatter.