Struct OpenObjectRequest 

#[non_exhaustive]
pub struct OpenObjectRequest {
    pub bucket: String,
    pub object: String,
    pub generation: i64,
    pub if_generation_match: Option<i64>,
    pub if_generation_not_match: Option<i64>,
    pub if_metageneration_match: Option<i64>,
    pub if_metageneration_not_match: Option<i64>,
    pub common_object_request_params: Option<CommonObjectRequestParams>,
    pub ranges: Vec<ReadRange>,
}

The request type for a bidi read object streaming RPC.

This type is used in the Storage stub to represent a request for open_object. Applications rarely use this type directly, but it might be used in tests where the client library is being mocked.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bucket: String

The bucket containing the target object.

object: String

The target object name.

generation: i64

The target object generation. If zero, then target the latest version of the object.

if_generation_match: Option<i64>

If set, return an error if the current generation does not match the value.

if_generation_not_match: Option<i64>

If set, return an error if the current generation matches the value.

if_metageneration_match: Option<i64>

If set, return an error if the current metageneration does not match the value.

if_metageneration_not_match: Option<i64>

If set, return an error if the current metageneration matches the value.

common_object_request_params: Option<CommonObjectRequestParams>

Parameters that can be passed to any object request.

At the moment, these are only encryption parameters for Customer-Supplied Encryption Keys.

ranges: Vec<ReadRange>

The list of ranges to read as part of the initial request.

Applications can open an object and issue a read request in the same RPC using OpenObject::send_and_read.

In the future, we may offer methods to issue more than one read request.

Implementations

impl OpenObjectRequest

pub fn set_bucket<T>(self, v: T) -> Self

where T: Into<String>,

Sets the bucket field.

pub fn set_object<T>(self, v: T) -> Self

where T: Into<String>,

Sets the object field.

pub fn set_generation(self, v: i64) -> Self

Sets the generation field.

pub fn set_if_generation_match(self, v: i64) -> Self

Sets the if_generation_match field.

pub fn set_or_clear_if_generation_match(self, v: Option<i64>) -> Self

Sets the if_generation_match field.

pub fn set_if_generation_not_match(self, v: i64) -> Self

Sets the if_generation_not_match field.

pub fn set_or_clear_if_generation_not_match(self, v: Option<i64>) -> Self

Sets the if_generation_not_match field.

pub fn set_if_metageneration_match(self, v: i64) -> Self

Sets the if_metageneration_match field.

pub fn set_or_clear_if_metageneration_match(self, v: Option<i64>) -> Self

Sets the if_metageneration_match field.

pub fn set_if_metageneration_not_match(self, v: i64) -> Self

Sets the if_metageneration_not_match field.

pub fn set_or_clear_if_metageneration_not_match(self, v: Option<i64>) -> Self

Sets the if_metageneration_not_match field.

pub fn set_common_object_request_params( self, v: CommonObjectRequestParams, ) -> Self

Sets the common_object_request_params field.

pub fn set_or_clear_common_object_request_params( self, v: Option<CommonObjectRequestParams>, ) -> Self

Sets the common_object_request_params field.

Trait Implementations

impl Clone for OpenObjectRequest

fn clone(&self) -> OpenObjectRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenObjectRequest

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

Formats the value using the given formatter.

impl Default for OpenObjectRequest

fn default() -> OpenObjectRequest

Returns the “default value” for a type.

impl PartialEq for OpenObjectRequest

fn eq(&self, other: &OpenObjectRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OpenObjectRequest