Struct worker::Bucket

pub struct Bucket { /* private fields */ }

An instance of the R2 bucket binding.

Implementations

impl Bucket

pub async fn head(&self, key: impl Into<String>) -> Result<Option<Object>>

Retrieves the Object for the given key containing only object metadata, if the key exists.

pub fn get(&self, key: impl Into<String>) -> GetOptionsBuilder<'_>

Retrieves the Object for the given key containing object metadata and the object body if the key exists. In the event that a precondition specified in options fails, get() returns an Object with no body.

pub fn put( &self, key: impl Into<String>, value: impl Into<Data> ) -> PutOptionsBuilder<'_>

Stores the given value and metadata under the associated key. Once the write succeeds, returns an Object containing metadata about the stored Object.

R2 writes are strongly consistent. Once the future resolves, all subsequent read operations will see this key value pair globally.

pub async fn delete(&self, key: impl Into<String>) -> Result<()>

Deletes the given value and metadata under the associated key. Once the delete succeeds, returns void.

R2 deletes are strongly consistent. Once the Promise resolves, all subsequent read operations will no longer see this key value pair globally.

pub fn list(&self) -> ListOptionsBuilder<'_>

Returns an Objects containing a list of Objectss contained within the bucket. By default, returns the first 1000 entries.

pub fn create_multipart_upload( &self, key: impl Into<String> ) -> CreateMultipartUploadOptionsBuilder<'_>

Creates a multipart upload.

Returns a MultipartUpload value representing the newly created multipart upload. Once the multipart upload has been created, the multipart upload can be immediately interacted with globally, either through the Workers API, or through the S3 API.

pub fn resume_multipart_upload( &self, key: impl Into<String>, upload_id: impl Into<String> ) -> Result<MultipartUpload>

Returns an object representing a multipart upload with the given key and uploadId.

The operation does not perform any checks to ensure the validity of the uploadId, nor does it verify the existence of a corresponding active multipart upload. This is done to minimize latency before being able to call subsequent operations on the returned object.

Trait Implementations

impl AsRef<JsValue> for Bucket

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl EnvBinding for Bucket

const TYPE_NAME: &'static str = "R2Bucket"

fn get(val: JsValue) -> Result<Self>

impl From<Bucket> for JsValue

fn from(bucket: Bucket) -> Self

Converts to this type from the input type.

impl JsCast for Bucket

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> boolwhere T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> Twhere T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &Twhere T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> boolwhere T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.