Struct PutBuilder 

pub struct PutBuilder { /* private fields */ }

A put request builder.

Implementations

impl PutBuilder

pub fn key(self, key: impl Into<ObjectKey>) -> Self

Sets an explicit object key.

If a key is specified, the object will be stored under that key. Otherwise, the Objectstore server will automatically assign a random key, which is then returned from this request.

pub fn compress(self, compression: impl Into<Option<Compression>>) -> Self

Sets an explicit compression algorithm to be used for this payload.

The client compresses the payload while uploading it and records the algorithm in the object’s metadata. None should be used if no compression should be performed by the client, either because the payload is uncompressible (such as a media format), or if the compression should not be recorded for this object.

If the payload is already compressed and the algorithm should still be recorded, use precompressed instead.

By default, the compression algorithm set on this Session’s Usecase is used (see with_compression).

Example

session.put(media)
    .compress(None) // uncompressible payload
    .send()
    .await
    .unwrap();

pub fn compression(self, compression: impl Into<Option<Compression>>) -> Self

👎Deprecated since 0.3.0:

renamed to compress

Deprecated in favor of compress.

pub fn precompressed(self, compression: Compression) -> Self

Declares that the payload is already compressed with the given algorithm.

The payload is uploaded verbatim, and the algorithm is recorded in the object’s metadata so that downloads decompress it transparently. Use this to hand pre-compressed data to the client without paying for another compression pass.

This overrides the compression algorithm set on this Session’s Usecase. To have the client perform the compression instead, use compress.

Example

session.put(zstd_data)
    .precompressed(Compression::Zstd)
    .send()
    .await
    .unwrap();

pub fn expiration_policy(self, expiration_policy: ExpirationPolicy) -> Self

Sets the expiration policy of the object to be uploaded.

By default, the expiration policy set on this Session’s Usecase is used.

pub fn content_type(self, content_type: impl Into<Cow<'static, str>>) -> Self

Sets the content type of the object to be uploaded.

You can use the utility function crate::utils::guess_mime_type to attempt to guess a content_type based on magic bytes.

pub fn origin(self, origin: impl Into<String>) -> Self

Sets the origin of the object, typically the IP address of the original source.

This is an optional but encouraged field that tracks where the payload was originally obtained from. For example, the IP address of the Sentry SDK or CLI that uploaded the data.

Example

session.put("data")
    .origin("203.0.113.42")
    .send()
    .await
    .unwrap();

pub fn filename(self, filename: impl Into<String>) -> Self

Sets the filename of the object.

When present, the server will include a Content-Disposition: attachment; filename="<filename>" header in GET responses, prompting browsers and download tools to save the file under this name.

pub fn set_metadata(self, metadata: impl Into<BTreeMap<String, String>>) -> Self

This sets the custom metadata to the provided map.

It will clear any previously set metadata.

pub fn append_metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Appends they key/value to the custom metadata of this object.

impl PutBuilder

pub async fn send(self) -> Result<PutResponse>

Sends the built put request to the upstream service.

Trait Implementations

impl Debug for PutBuilder

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

Formats the value using the given formatter.