Struct cloud_storage::object::ListRequest

pub struct ListRequest {
    pub delimiter: Option<String>,
    pub end_offset: Option<String>,
    pub include_trailing_delimiter: Option<bool>,
    pub max_results: Option<usize>,
    pub page_token: Option<String>,
    pub prefix: Option<String>,
    pub projection: Option<Projection>,
    pub start_offset: Option<String>,
    pub versions: Option<bool>,
}

The request that is supplied to perform Object::list. See the Google Cloud Storage API reference for more details.

Fields

delimiter: Option<String>

When specified, allows the list to operate like a directory listing by splitting the object location on this delimiter.

end_offset: Option<String>

Filter results to objects whose names are lexicographically before end_offset. If start_offset is also set, the objects listed have names between start_offset (inclusive) and end_offset (exclusive).

include_trailing_delimiter: Option<bool>

If true, objects that end in exactly one instance of delimiter have their metadata included in items in addition to the relevant part of the object name appearing in prefixes.

max_results: Option<usize>

Maximum combined number of entries in items and prefixes to return in a single page of responses. Because duplicate entries in prefixes are omitted, fewer total results may be returned than requested. The service uses this parameter or 1,000 items, whichever is smaller.

page_token: Option<String>

A previously-returned page token representing part of the larger set of results to view. The page_token is an encoded field that marks the name and generation of the last object in the returned list. In a subsequent request using the page_token, items that come after the page_token are shown (up to max_results).

If the page token is provided, all objects starting at that page token are queried

prefix: Option<String>

Filter results to include only objects whose names begin with this prefix.

projection: Option<Projection>

Set of properties to return. Defaults to NoAcl.

start_offset: Option<String>

Filter results to objects whose names are lexicographically equal to or after start_offset. If end_offset is also set, the objects listed have names between start_offset (inclusive) and end_offset (exclusive).

versions: Option<bool>

If true, lists all versions of an object as distinct results in order of increasing generation number. The default value for versions is false. For more information, see Object Versioning.

Trait Implementations

impl Clone for ListRequest

fn clone(&self) -> ListRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListRequest

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

Formats the value using the given formatter.

impl Default for ListRequest

fn default() -> ListRequest

Returns the “default value” for a type.

impl PartialEq for ListRequest

fn eq(&self, other: &ListRequest) -> 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 Serialize for ListRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ListRequest