Struct stripe::File

pub struct File {
    pub id: FileId,
    pub created: Timestamp,
    pub expires_at: Option<Timestamp>,
    pub filename: Option<String>,
    pub links: Option<List<FileLink>>,
    pub purpose: FilePurpose,
    pub size: u64,
    pub title: Option<String>,
    pub type_: Option<String>,
    pub url: Option<String>,
}

The resource representing a Stripe “File”.

For more details see https://stripe.com/docs/api/files/object

Fields

id: FileId

Unique identifier for the object.

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

expires_at: Option<Timestamp>

The file expires and isn’t available at this time in epoch seconds.

filename: Option<String>

The suitable name for saving the file to a filesystem.

links: Option<List<FileLink>>

A list of file links that point at this file.

purpose: FilePurpose

The purpose of the uploaded file.

size: u64

The size of the file object in bytes.

title: Option<String>

A suitable title for the document.

type_: Option<String>

The returned file type (for example, csv, pdf, jpg, or png).

url: Option<String>

Use your live secret API key to download the file from this URL.

Implementations

impl File

pub fn list(client: &Client, params: &ListFiles<'_>) -> Response<List<File>>

Returns a list of the files that your account has access to.

Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

pub fn retrieve(client: &Client, id: &FileId, expand: &[&str]) -> Response<File>

Retrieves the details of an existing file object.

After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Default for File

fn default() -> File

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for File

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Object for File

type Id = FileId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object’s type, typically represented in wire format as the object property.

impl Serialize for File

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

where __S: Serializer,

Serialize this value into the given Serde serializer.