Struct ElementConfig 

pub struct ElementConfig { /* private fields */ }

The configuration a checkout page hands to the payment element.

The struct is transport-free on purpose: the browser binds it to Stripe.js at mount time, so every field can be exercised without a DOM and stays unit-testable on the host target.

Accessors are generated by #[derive(Data)]. The client secret is pinned at construction: it authenticates a mount against Stripe, so allowing it to be swapped after the fact would let a caller who already holds the config redirect the element at another intent.

Implementations

impl ElementConfig

pub fn new(client_secret: String) -> Self

Build a configuration for a client secret.

Arguments

• String - the client secret Stripe issued for the intent.

Returns

• Self - the configuration, defaulting to the payment variant.

pub fn with_kind(self, kind: ElementKind) -> Self

Return a copy of this configuration rendering the given variant.

Arguments

• ElementKind - the variant the page should mount.

Returns

• Self - the configuration with the variant switched.

pub fn with_locale(self, locale: String) -> Self

Return a copy of this configuration with an explicit locale.

Arguments

• String - the locale tag, such as en or zh-CN.

Returns

• Self - the configuration with the locale set.

pub fn effective_locale(&self) -> &str

Return the locale actually sent to Stripe.js.

An empty locale means the host page did not choose one, so the element falls back to the crate default rather than sending an empty string Stripe would reject.

Returns

• &str - the effective locale.

pub fn is_mountable(&self) -> bool

Return whether the configuration can mount an element.

Stripe rejects an empty client secret, so a blank one has to fail before the element is ever created.

Returns

• bool - true when a client secret is present.

pub fn build_options(&self) -> Result<String, ElementError>

Render the options object Stripe.js expects for an element.

Stripe.js is called from JavaScript, so the crate passes a JSON options object rather than typed arguments. Building it here keeps the payload identical to what a hand-written mount would send and lets the tests assert on it without a browser.

Returns

• Result<String, ElementError> - the JSON options, or MissingClientSecret when the configuration is unusable.

pub fn require_stripe_js(available: bool) -> Result<(), ElementError>

Return whether the page has loaded the Stripe.js global.

The check is a pure boolean test against the global registry, which keeps it callable from both wasm and the host target.

Arguments

• bool - whether window.Stripe resolved when probed.

Returns

• Result<(), ElementError> - Ok(()) when Stripe.js is present, StripeJsUnavailable otherwise.

pub fn preflight( &self, has_mount_target: bool, stripe_js_loaded: bool, ) -> Result<(), ElementError>

Check every precondition a mount needs, in the order a caller hits them.

Arguments

• bool - whether the page has a mount target.
• bool - whether Stripe.js is loaded.

Returns

• Result<(), ElementError> - Ok(()) when the element can mount, or the first unmet precondition.

impl ElementConfig

pub fn get_client_secret(&self) -> &String

pub fn get_mut_client_secret(&mut self) -> &mut String

pub fn get_kind(&self) -> ElementKind

pub fn get_mut_kind(&mut self) -> &mut ElementKind

pub fn set_kind(&mut self, val: ElementKind) -> &mut Self

pub fn set_locale(&mut self, val: impl AsRef<str>) -> &mut Self

pub fn get_locale(&self) -> &String

pub fn get_mut_locale(&mut self) -> &mut String

Trait Implementations

impl Clone for ElementConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElementConfig

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

Formats the value using the given formatter.

impl Eq for ElementConfig

impl PartialEq for ElementConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ElementConfig