Struct vss_client::types::GetObjectRequest

pub struct GetObjectRequest {
    pub store_id: String,
    pub key: String,
}

Request payload to be used for GetObject API call to server.

Fields

store_id: String

store_id is a keyspace identifier. Ref: https://en.wikipedia.org/wiki/Keyspace_(distributed_data_store) All APIs operate within a single store_id. It is up to clients to use single or multiple stores for their use-case. This can be used for client-isolation/ rate-limiting / throttling on the server-side. Authorization and billing can also be performed at the store_id level.

key: String

The key of the value to be fetched.

If the specified key does not exist, returns ErrorCode.NO_SUCH_KEY_EXCEPTION in the the ErrorResponse.

Consistency Guarantee: Get(read) operations against a key are consistent reads and will reflect all previous writes, since Put/Write provides read-after-write and read-after-update consistency guarantees.

Read Isolation: Get/Read operations against a key are ensured to have read-committed isolation. Ref: https://en.wikipedia.org/wiki/Isolation_(database_systems)#Read_committed

Trait Implementations

impl Clone for GetObjectRequest

fn clone(&self) -> GetObjectRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetObjectRequest

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

Formats the value using the given formatter.

impl Default for GetObjectRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for GetObjectRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for GetObjectRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for GetObjectRequest