Struct stripe::generated::core::file::ListFiles

pub struct ListFiles<'a> {
    pub created: Option<RangeQuery<Timestamp>>,
    pub ending_before: Option<FileId>,
    pub expand: &'a [&'a str],
    pub limit: Option<u64>,
    pub purpose: Option<FilePurpose>,
    pub starting_after: Option<FileId>,
}

The parameters for File::list.

Fields

created: Option<RangeQuery<Timestamp>>

ending_before: Option<FileId>

A cursor for use in pagination.

ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

limit: Option<u64>

A limit on the number of objects to be returned.

Limit can range between 1 and 100, and the default is 10.

purpose: Option<FilePurpose>

Filter queries by the file purpose.

If you don’t provide a purpose, the queries return unfiltered files.

starting_after: Option<FileId>

A cursor for use in pagination.

starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Implementations

impl<'a> ListFiles<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for ListFiles<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ListFiles<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ListFiles<'a>

fn default() -> ListFiles<'a>

Returns the “default value” for a type.

impl<'a> Serialize for ListFiles<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.