Enum FxaEvent

pub enum FxaEvent {
    Initialize {
        device_config: DeviceConfig,
    },
    BeginOAuthFlow {
        scopes: Vec<String>,
        entrypoint: String,
    },
    BeginPairingFlow {
        pairing_url: String,
        scopes: Vec<String>,
        entrypoint: String,
    },
    CompleteOAuthFlow {
        code: String,
        state: String,
    },
    CancelOAuthFlow,
    CheckAuthorizationStatus,
    Disconnect,
    CallGetProfile,
}

Fxa event

These are the events that consumers send to [crate::FxaStateMachine::process_event]

Variants

Initialize

Initialize the state machine. This must be the first event sent.

Fields

device_config: DeviceConfig

BeginOAuthFlow

Begin an oauth flow

If successful, the state machine will transition the FxaState::Authenticating. The next step is to navigate the user to the oauth_url and let them sign and authorize the client.

Fields

scopes: Vec<String>

entrypoint: String

BeginPairingFlow

Begin an oauth flow using a URL from a pairing code

If successful, the state machine will transition the FxaState::Authenticating. The next step is to navigate the user to the oauth_url and let them sign and authorize the client.

Fields

pairing_url: String

scopes: Vec<String>

entrypoint: String

CompleteOAuthFlow

Complete an OAuth flow.

Send this event after the user has navigated through the OAuth flow and has reached the redirect URI. Extract code and state from the query parameters or web channel. If successful the state machine will transition to FxaState::Connected.

Fields

code: String

state: String

CancelOAuthFlow

Cancel an OAuth flow.

Use this to cancel an in-progress OAuth, returning to FxaState::Disconnected so the process can begin again.

CheckAuthorizationStatus

Check the authorization status for a connected account.

Send this when issues are detected with the auth tokens for a connected account. It will double check for authentication issues with the account. If it detects them, the state machine will transition to FxaState::AuthIssues. From there you can start an OAuth flow again to re-connect the user.

Disconnect

Disconnect the user

Send this when the user is asking to be logged out. The state machine will transition to FxaState::Disconnected.

CallGetProfile

Force a call to FirefoxAccount::get_profile

This is used for testing the auth/network retry code, since it hits the network and requires and auth token.

Trait Implementations

impl Clone for FxaEvent

fn clone(&self) -> FxaEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for FxaEvent

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

impl Debug for FxaEvent

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

Formats the value using the given formatter.

impl Display for FxaEvent

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for FxaEvent

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 FxaEvent

type FfiType = <FxaEvent 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 FxaEvent

type LiftType = FxaEvent

impl<UT> LiftReturn<UT> for FxaEvent

type ReturnType = <FxaEvent 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 FxaEvent

type FfiType = <FxaEvent 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 FxaEvent

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for FxaEvent

type ReturnType = <FxaEvent 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 PartialEq for FxaEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<UT> TypeId<UT> for FxaEvent

const TYPE_ID_META: MetadataBuffer

impl Eq for FxaEvent

impl StructuralPartialEq for FxaEvent