Struct object_store::GetOptions

pub struct GetOptions {
    pub if_match: Option<String>,
    pub if_none_match: Option<String>,
    pub if_modified_since: Option<DateTime<Utc>>,
    pub if_unmodified_since: Option<DateTime<Utc>>,
    pub range: Option<GetRange>,
    pub version: Option<String>,
    pub head: bool,
}

Options for a get request, such as range

Fields

if_match: Option<String>

Request will succeed if the ObjectMeta::e_tag matches otherwise returning Error::Precondition

See https://datatracker.ietf.org/doc/html/rfc9110#name-if-match

Examples:

If-Match: "xyzzy"
If-Match: "xyzzy", "r2d2xxxx", "c3piozzzz"
If-Match: *

if_none_match: Option<String>

Request will succeed if the ObjectMeta::e_tag does not match otherwise returning Error::NotModified

See https://datatracker.ietf.org/doc/html/rfc9110#section-13.1.2

Examples:

If-None-Match: "xyzzy"
If-None-Match: "xyzzy", "r2d2xxxx", "c3piozzzz"
If-None-Match: *

if_modified_since: Option<DateTime<Utc>>

Request will succeed if the object has been modified since

https://datatracker.ietf.org/doc/html/rfc9110#section-13.1.3

if_unmodified_since: Option<DateTime<Utc>>

Request will succeed if the object has not been modified since otherwise returning Error::Precondition

Some stores, such as S3, will only return NotModified for exact timestamp matches, instead of for any timestamp greater than or equal.

https://datatracker.ietf.org/doc/html/rfc9110#section-13.1.4

range: Option<GetRange>

Request transfer of only the specified range of bytes otherwise returning Error::NotModified

https://datatracker.ietf.org/doc/html/rfc9110#name-range

version: Option<String>

Request a particular object version

head: bool

Request transfer of no content

https://datatracker.ietf.org/doc/html/rfc9110#name-head

Trait Implementations

impl Debug for GetOptions

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

Formats the value using the given formatter.

impl Default for GetOptions

fn default() -> GetOptions

Returns the “default value” for a type.