Struct aws_sdk_s3::operation::list_objects::ListObjectsOutput
source · #[non_exhaustive]pub struct ListObjectsOutput {
pub is_truncated: Option<bool>,
pub marker: Option<String>,
pub next_marker: Option<String>,
pub contents: Option<Vec<Object>>,
pub name: Option<String>,
pub prefix: Option<String>,
pub delimiter: Option<String>,
pub max_keys: Option<i32>,
pub common_prefixes: Option<Vec<CommonPrefix>>,
pub encoding_type: Option<EncodingType>,
pub request_charged: Option<RequestCharged>,
/* private fields */
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.is_truncated: Option<bool>
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
marker: Option<String>
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
next_marker: Option<String>
When the response is truncated (the IsTruncated
element value in the response is true
), you can use the key name in this field as the marker
parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.
This element is returned only if you have the delimiter
request parameter specified. If the response does not include the NextMarker
element and it is truncated, you can use the value of the last Key
element in the response as the marker
parameter in the subsequent request to get the next set of object keys.
contents: Option<Vec<Object>>
Metadata about each object returned.
name: Option<String>
The bucket name.
prefix: Option<String>
Keys that begin with the indicated prefix.
delimiter: Option<String>
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys
value.
max_keys: Option<i32>
The maximum number of keys returned in the response body.
common_prefixes: Option<Vec<CommonPrefix>>
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.
A response can contain CommonPrefixes
only if you specify a delimiter.
CommonPrefixes
contains all (if there are any) keys between Prefix
and the next occurrence of the string specified by the delimiter.
CommonPrefixes
lists keys that act like subdirectories in the directory specified by Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash (/
), as in notes/summer/july
, the common prefix is notes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
encoding_type: Option<EncodingType>
Encoding type used by Amazon S3 to encode object keys in the response. If using url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.
request_charged: Option<RequestCharged>
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
Implementations§
source§impl ListObjectsOutput
impl ListObjectsOutput
sourcepub fn is_truncated(&self) -> Option<bool>
pub fn is_truncated(&self) -> Option<bool>
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
sourcepub fn marker(&self) -> Option<&str>
pub fn marker(&self) -> Option<&str>
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
sourcepub fn next_marker(&self) -> Option<&str>
pub fn next_marker(&self) -> Option<&str>
When the response is truncated (the IsTruncated
element value in the response is true
), you can use the key name in this field as the marker
parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.
This element is returned only if you have the delimiter
request parameter specified. If the response does not include the NextMarker
element and it is truncated, you can use the value of the last Key
element in the response as the marker
parameter in the subsequent request to get the next set of object keys.
sourcepub fn contents(&self) -> &[Object]
pub fn contents(&self) -> &[Object]
Metadata about each object returned.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .contents.is_none()
.
sourcepub fn delimiter(&self) -> Option<&str>
pub fn delimiter(&self) -> Option<&str>
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys
value.
sourcepub fn max_keys(&self) -> Option<i32>
pub fn max_keys(&self) -> Option<i32>
The maximum number of keys returned in the response body.
sourcepub fn common_prefixes(&self) -> &[CommonPrefix]
pub fn common_prefixes(&self) -> &[CommonPrefix]
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.
A response can contain CommonPrefixes
only if you specify a delimiter.
CommonPrefixes
contains all (if there are any) keys between Prefix
and the next occurrence of the string specified by the delimiter.
CommonPrefixes
lists keys that act like subdirectories in the directory specified by Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash (/
), as in notes/summer/july
, the common prefix is notes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .common_prefixes.is_none()
.
sourcepub fn encoding_type(&self) -> Option<&EncodingType>
pub fn encoding_type(&self) -> Option<&EncodingType>
Encoding type used by Amazon S3 to encode object keys in the response. If using url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.
sourcepub fn request_charged(&self) -> Option<&RequestCharged>
pub fn request_charged(&self) -> Option<&RequestCharged>
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
source§impl ListObjectsOutput
impl ListObjectsOutput
sourcepub fn builder() -> ListObjectsOutputBuilder
pub fn builder() -> ListObjectsOutputBuilder
Creates a new builder-style object to manufacture ListObjectsOutput
.
Trait Implementations§
source§impl Clone for ListObjectsOutput
impl Clone for ListObjectsOutput
source§fn clone(&self) -> ListObjectsOutput
fn clone(&self) -> ListObjectsOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListObjectsOutput
impl Debug for ListObjectsOutput
source§impl PartialEq for ListObjectsOutput
impl PartialEq for ListObjectsOutput
source§impl RequestId for ListObjectsOutput
impl RequestId for ListObjectsOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.source§impl RequestIdExt for ListObjectsOutput
impl RequestIdExt for ListObjectsOutput
source§fn extended_request_id(&self) -> Option<&str>
fn extended_request_id(&self) -> Option<&str>
impl StructuralPartialEq for ListObjectsOutput
Auto Trait Implementations§
impl Freeze for ListObjectsOutput
impl RefUnwindSafe for ListObjectsOutput
impl Send for ListObjectsOutput
impl Sync for ListObjectsOutput
impl Unpin for ListObjectsOutput
impl UnwindSafe for ListObjectsOutput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)