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 compression(self, compression: impl Into<Option<Compression>>) -> Self

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

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 user will handle any kind of compression, without the clients knowledge.

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

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 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.