Skip to main content

File

Struct File 

Source
pub struct File {
    pub id: Option<String>,
    pub object: Option<String>,
    pub created: Option<i64>,
    pub expires_at: Option<i64>,
    pub filename: Option<String>,
    pub links: Option<Links>,
    pub purpose: Option<String>,
    pub size: Option<i64>,
    pub title: Option<String>,
    pub type_field: Option<String>,
    pub url: Option<String>,
    pub file: Option<Vec<u8>>,
}
Expand description

Represents a file hosted on Stripe’s servers.

Fields§

§id: Option<String>§object: Option<String>§created: Option<i64>§expires_at: Option<i64>§filename: Option<String>§links: Option<Links>§purpose: Option<String>§size: Option<i64>§title: Option<String>§type_field: Option<String>§url: Option<String>§file: Option<Vec<u8>>

Implementations§

Source§

impl File

Source

pub fn new() -> Self

Returns an empty File object

§Examples
let mut file = payup::stripe::File::new();
file.title = Some(format!("Title"));
Source

pub async fn async_get(creds: Auth, id: String) -> Result<Self, Error>

Asynchronously retrieves a file with the given ID.

§Arguments
  • auth - payup::stripe::Auth::new(client, secret)
  • id - The id of the file you want to retrieve.
§Examples
// Create the Authentication refererence
let auth = payup::stripe::Auth::new(client, secret);

// Fetch customer using id
let file = payup::stripe::File::async_get(auth, "ch_").await?;
Source

pub async fn async_list(creds: Auth) -> Result<Vec<Self>, Error>

Asynchronously returns all stripe Files.

§Arguments
  • auth - payup::stripe::Auth::new(client, secret)
§Examples
// Create the Authentication refererence
let auth = payup::stripe::Auth::new(client, secret);

// Fetch all customers from stripe
let disputes = payup::stripe::Dispute::async_list(auth).await?;
Source

pub async fn async_post(&self, creds: Auth) -> Result<Self, Error>

Asynchronously POSTs a new File to the stripe api

§Examples
// Create the Authentication refererence
let auth = payup::stripe::Auth::new(client, secret);

let mut file = payup::stripe::File::new();
ley bytes: Vec<u8> = Vec::new();
charge.amount = Some(100);
file.file = Some(bytes);

// The purpose of the uploaded file.
// Possible enum values: account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, identity_document, pci_document, tax_document_user_upload
file.purpose = Some(format!("cust_"));

file = file.post(auth.clone()).await?;
Source

pub fn post(&self, creds: Auth) -> Result<Self, Error>

POSTs a new File to the stripe api

§Examples
// Create the Authentication refererence
let auth = payup::stripe::Auth::new(client, secret);

let mut file = payup::stripe::File::new();
ley bytes: Vec<u8> = Vec::new();
charge.amount = Some(100);
file.file = Some(bytes);

// The purpose of the uploaded file.
// Possible enum values: account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, identity_document, pci_document, tax_document_user_upload
file.purpose = Some(format!("cust_"));

file = file.post(auth.clone())?;
Source

pub fn get(creds: Auth, id: String) -> Result<Self, Error>

Retrieves the dispute with the given ID.

§Arguments
  • auth - payup::stripe::Auth::new(client, secret)
  • id - The id of the dispute you want to retrieve.
§Examples
// Create the Authentication refererence
let auth = payup::stripe::Auth::new(client, secret);

// Fetch customer using id
let dispute = payup::stripe::Dispute::get(auth, "ch_")?;
Source

pub fn list(creds: Auth) -> Result<Vec<Self>, Error>

Returns all stripe disputes.

§Arguments
  • auth - payup::stripe::Auth::new(client, secret)
§Examples
// Create the Authentication refererence
let auth = payup::stripe::Auth::new(client, secret);

// Fetch all customers from stripe
let charges = payup::stripe::Dispute::list(auth)?;

Trait Implementations§

Source§

impl Clone for File

Source§

fn clone(&self) -> File

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for File

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for File

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for File

§

impl RefUnwindSafe for File

§

impl Send for File

§

impl Sync for File

§

impl Unpin for File

§

impl UnsafeUnpin for File

§

impl UnwindSafe for File

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more