Struct FormField 

pub struct FormField { /* private fields */ }

A form field destined for Stripe’s application/x-www-form-urlencoded request body.

Stripe’s REST API takes nested parameters as bracketed keys rather than JSON, so metadata[order_id]=42 is the wire form. A FormField is one such key and value pair; the builder below assembles the whole body.

Read accessors are generated by #[derive(Getter)].

Implementations

impl FormField

pub const fn new(key: String, value: String) -> FormField

Build one bracketed parameter.

Arguments

• String - the bracketed parameter name.
• String - the field’s value.

Returns

• Self - the field.

pub fn percent_encode(raw: &str) -> String

Percent-encode a form key or value for Stripe’s request body.

Stripe expects application/x-www-form-urlencoded, which encodes a space as + and every other reserved character as %XX over uppercase hex digits. Encoding the bracketed key is what turns metadata[order_id] into metadata%5Border_id%5D.

Arguments

• &str - the raw key or value to escape.

Returns

• String - the percent-encoded text.

pub fn is_unreserved(byte: u8) -> bool

Return whether a byte may appear in a form body unescaped.

This is the RFC 3986 unreserved set plus the five characters application/x-www-form-urlencoded also passes through: alphanumerics and - _ . ~. Brackets deliberately fall outside the set, which is what turns metadata[order_id] into metadata%5Border_id%5D.

Arguments

• u8 - the byte to classify.

Returns

• bool - true when the byte needs no percent-escaping.

pub fn metadata_key(key: &str) -> String

Build the bracketed key Stripe uses for one metadata entry.

Arguments

• &str - the bare metadata key such as order_id.

Returns

• String - the full parameter name metadata[order_id].

pub fn expand_key(index: usize) -> String

Build the bracketed key Stripe uses for one expand[] entry.

Stripe takes repeated list parameters as expand[0], expand[1], so a caller expanding two fields must get two distinct keys.

Arguments

• usize - the field’s position in the expand list.

Returns

• String - the full parameter name expand[0].

impl FormField

pub fn get_key(&self) -> &String

pub fn get_value(&self) -> &String

Trait Implementations

impl Clone for FormField

fn clone(&self) -> FormField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormField

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

Formats the value using the given formatter.

impl Eq for FormField

impl PartialEq for FormField

fn eq(&self, other: &FormField) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FormField