Struct FxaConfig

pub struct FxaConfig {
    pub server: FxaServer,
    pub client_id: String,
    pub redirect_uri: String,
    pub token_server_url_override: Option<String>,
}

Fields

server: FxaServer

FxaServer to connect with

client_id: String

registered OAuth client id of the application.

redirect_uri: String

redirect_uri - the registered OAuth redirect URI of the application.

token_server_url_override: Option<String>

URL for the user’s Sync Tokenserver. This can be used to support users who self-host their sync data. If None then it will default to the Mozilla-hosted Sync server.

Note: this lives here for historical reasons, but probably shouldn’t. Applications pass the token server URL they get from fxa-client to SyncManager. It would be simpler to cut out fxa-client out of the middle and have applications send the overridden URL directly to SyncManager.

Implementations

impl FxaConfig

pub fn release(client_id: impl ToString, redirect_uri: impl ToString) -> Self

pub fn stable(client_id: impl ToString, redirect_uri: impl ToString) -> Self

pub fn stage(client_id: impl ToString, redirect_uri: impl ToString) -> Self

pub fn china(client_id: impl ToString, redirect_uri: impl ToString) -> Self

pub fn dev(client_id: impl ToString, redirect_uri: impl ToString) -> Self

Trait Implementations

impl Clone for FxaConfig

fn clone(&self) -> FxaConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for FxaConfig

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for FxaConfig

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for FxaConfig

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for FxaConfig

type FfiType = <FxaConfig as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for FxaConfig

type LiftType = FxaConfig

impl<UT> LiftReturn<UT> for FxaConfig

type ReturnType = <FxaConfig as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for FxaConfig

type FfiType = <FxaConfig as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for FxaConfig

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for FxaConfig

type ReturnType = <FxaConfig as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for FxaConfig

const TYPE_ID_META: MetadataBuffer