Enum CloseTabsResult 

pub enum CloseTabsResult {
    Ok,
    TabsNotClosed {
        urls: Vec<String>,
    },
}

The result of invoking a “close tabs” command.

If FirefoxAccount::close_tabs is called with more URLs than can fit into a single command payload, the URLs will be chunked and sent in multiple commands.

Chunking breaks the atomicity of a “close tabs” command, but reduces the number of these commands that FxA sends to other devices. This is critical for platforms like iOS, where every command triggers a push message that must show a user-visible notification.

Variants

Ok

All URLs passed to FirefoxAccount::close_tabs were chunked and sent in one or more device commands.

TabsNotClosed

One or more URLs passed to FirefoxAccount::close_tabs couldn’t be sent in a device command. The caller can assume that:

1. Any URL in the returned list of urls was not sent, and should be retried.
2. All other URLs that were passed to FirefoxAccount::close_tabs, and that are not in the list of urls, were chunked and sent.

Fields

urls: Vec<String>

Trait Implementations

impl Clone for CloseTabsResult

fn clone(&self) -> CloseTabsResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for CloseTabsResult

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

impl Debug for CloseTabsResult

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for CloseTabsResult

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 CloseTabsResult

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

type LiftType = CloseTabsResult

impl<UT> LiftReturn<UT> for CloseTabsResult

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

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

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for CloseTabsResult

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

fn eq(&self, other: &CloseTabsResult) -> 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 CloseTabsResult

const TYPE_ID_META: MetadataBuffer

impl Eq for CloseTabsResult

impl StructuralPartialEq for CloseTabsResult