Struct ListObjectsV2

pub struct ListObjectsV2<'a> { /* private fields */ }

List all objects in the bucket.

If next_continuation_token is Some the response is truncated, and the rest of the list can be retrieved by reusing the ListObjectV2 action but with continuation-token set to the value of next_continuation_token received in the previous response.

Find out more about ListObjectsV2 from the AWS API Reference

Implementations

impl<'a> ListObjectsV2<'a>

pub fn new(bucket: &'a Bucket, credentials: Option<&'a Credentials>) -> Self

pub fn with_prefix(&mut self, prefix: impl Into<Cow<'a, str>>)

Limits the response to keys that begin with the specified prefix.

See https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html#API_ListObjectsV2_RequestSyntax for more infos.

Example

let mut list = bucket.list_objects_v2(None);
list.with_prefix("tamo");

pub fn with_delimiter(&mut self, delimiter: impl Into<Cow<'a, str>>)

A delimiter is a character that you use to group keys.

See https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html#API_ListObjectsV2_RequestSyntax for more infos.

Example

let mut list = bucket.list_objects_v2(None);
list.with_delimiter("/");

pub fn with_start_after(&mut self, start_after: impl Into<Cow<'a, str>>)

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

See https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html#API_ListObjectsV2_RequestSyntax for more infos.

Example

let mut list = bucket.list_objects_v2(None);
list.with_start_after("tamo"); // <- This token should come from a previous call to the list API.

pub fn with_continuation_token( &mut self, continuation_token: impl Into<Cow<'a, str>>, )

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

See https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html#API_ListObjectsV2_RequestSyntax for more infos.

Example

let mut list = bucket.list_objects_v2(None);
list.with_continuation_token("tamo"); // <- This token should come from a previous call to the list API.

pub fn with_max_keys(&mut self, max_keys: usize)

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

See https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html#API_ListObjectsV2_RequestSyntax for more infos.

Example

let mut list = bucket.list_objects_v2(None);
list.with_continuation_token("tamo"); // <- This token should come from a previous call to the list API.

pub fn parse_response( s: impl AsRef<[u8]>, ) -> Result<ListObjectsV2Response, DeError>

Parse the XML response from S3 into a struct.

Errors

Returns an error if the XML response could not be parsed.

pub fn parse_response_from_reader( s: impl Read, ) -> Result<ListObjectsV2Response, DeError>

Parse the XML response from S3 into a struct.

Errors

Returns an error if the XML response could not be parsed.

Trait Implementations

impl<'a> Clone for ListObjectsV2<'a>

fn clone(&self) -> ListObjectsV2<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ListObjectsV2<'a>

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

Formats the value using the given formatter.

impl<'a> S3Action<'a> for ListObjectsV2<'a>

const METHOD: Method = Method::Get

fn query_mut(&mut self) -> &mut Map<'a>

Get a mutable reference to the query string of this action

fn headers_mut(&mut self) -> &mut Map<'a>

Get a mutable reference to the signed headers of this action

fn sign_with_time(&self, expires_in: Duration, time: &Timestamp) -> Url

Takes the time at which the URL should be signed Used for testing purposes

fn sign(&self, expires_in: Duration) -> Url

Sign a request for this action, using METHOD for the Method