Struct Object 

pub struct Object { /* private fields */ }

Convenience wrapper around repeated operations on one object key.

Implementations

impl Object

pub fn reference(&self) -> &ObjectRef

Returns the referenced object key and version.

pub async fn stat(&mut self) -> Result<ObjectMeta, S3Error>

Fetches metadata for the current object.

pub async fn exists(&mut self) -> Result<bool, S3Error>

Reports whether the current object exists.

pub async fn stream( &mut self, options: Option<ReadOptions>, ) -> Result<ObjectReader, S3Error>

Opens a streaming reader for the current object.

pub async fn bytes( &mut self, options: Option<ReadOptions>, ) -> Result<Vec<u8>, S3Error>

Reads the entire object into memory.

pub async fn text( &mut self, options: Option<ReadOptions>, ) -> Result<String, S3Error>

Reads the entire object as UTF-8 text.

pub async fn json<T>( &mut self, options: Option<ReadOptions>, ) -> Result<T, S3Error>

where T: DeserializeOwned,

Reads and decodes the entire object as JSON.

pub async fn write<B>( &mut self, body: B, options: Option<WriteOptions>, ) -> Result<ObjectMeta, S3Error>

where B: AsRef<[u8]>,

Uploads a new object body.

pub async fn write_chunks<I, B>( &mut self, chunks: I, options: Option<WriteOptions>, ) -> Result<ObjectMeta, S3Error>

where I: IntoIterator<Item = B>, I::IntoIter: Send + 'static, B: AsRef<[u8]> + Send + 'static,

Uploads a pre-chunked object body.

pub async fn write_bytes( &mut self, body: impl AsRef<[u8]>, options: Option<WriteOptions>, ) -> Result<ObjectMeta, S3Error>

Uploads raw bytes.

pub async fn write_string( &mut self, body: impl AsRef<str>, options: Option<WriteOptions>, ) -> Result<ObjectMeta, S3Error>

Uploads UTF-8 text.

pub async fn write_json<T>( &mut self, value: &T, options: Option<WriteOptions>, ) -> Result<ObjectMeta, S3Error>

where T: Serialize + ?Sized,

Uploads JSON, defaulting the content type when omitted.

pub async fn delete(&mut self) -> Result<(), S3Error>

Deletes the current object.

pub async fn presign( &mut self, options: Option<PresignOptions>, ) -> Result<PresignResult, S3Error>

Creates a presigned URL for the current object.

pub async fn create_access_url( &mut self, options: Option<ObjectAccessURLOptions>, ) -> Result<ObjectAccessURL, S3Error>

Creates a host-mediated object-access URL for the current object.