Enum CliCommand 

pub enum CliCommand {
    GetBrowserInfo,
    ListWindows,
    OpenWindow,
    CloseWindow {
        window_id: u32,
    },
    SetWindowTitlePrefix {
        window_id: u32,
        prefix: String,
    },
    RemoveWindowTitlePrefix {
        window_id: u32,
    },
    ListTabs {
        window_id: u32,
    },
    OpenTab {
        window_id: u32,
        insert_before_tab_id: Option<u32>,
        insert_after_tab_id: Option<u32>,
        url: Option<String>,
        strip_credentials: bool,
    },
    ActivateTab {
        tab_id: u32,
    },
    NavigateTab {
        tab_id: u32,
        url: String,
    },
    CloseTab {
        tab_id: u32,
    },
    PinTab {
        tab_id: u32,
    },
    UnpinTab {
        tab_id: u32,
    },
    WarmupTab {
        tab_id: u32,
    },
    MuteTab {
        tab_id: u32,
    },
    UnmuteTab {
        tab_id: u32,
    },
    MoveTab {
        tab_id: u32,
        new_index: u32,
    },
    GoBack {
        tab_id: u32,
        steps: u32,
    },
    GoForward {
        tab_id: u32,
        steps: u32,
    },
    SubscribeEvents,
}

A command sent from the CLI to the mediator, and forwarded to the extension.

Variants

GetBrowserInfo

Retrieve information about the connected browser instance.

ListWindows

List all open windows with their tab summaries.

OpenWindow

Open a new browser window.

CloseWindow

Close an existing browser window.

Fields

window_id: u32

The ID of the window to close.

SetWindowTitlePrefix

Set the title prefix (Firefox titlePreface) for a window.

Fields

window_id: u32

The ID of the window whose prefix to set.

prefix: String

The prefix string to prepend to the window title.

RemoveWindowTitlePrefix

Remove the title prefix from a window, restoring the default title.

Fields

window_id: u32

The ID of the window whose prefix to remove.

ListTabs

List all tabs in a window with full details.

Fields

window_id: u32

The ID of the window whose tabs to list.

OpenTab

Open a new tab in a window.

Fields

window_id: u32

The ID of the window in which to open the tab.

insert_before_tab_id: Option<u32>

If set, the new tab will be inserted immediately before the tab with this ID.

insert_after_tab_id: Option<u32>

If set, the new tab will be inserted immediately after the tab with this ID.

url: Option<String>

The URL to load in the new tab, or the browser’s default new-tab page if absent.

strip_credentials: bool

If true, after the tab finishes loading the extension strips any user:password@ credentials from the URL and navigates to the clean URL.

This causes Firefox to cache the credentials (satisfying future auth challenges automatically) while leaving the tab displaying the URL without embedded credentials. Requires url to be set; ignored when url is absent.

ActivateTab

Activate a tab, making it the focused tab in its window.

Fields

tab_id: u32

The ID of the tab to activate.

NavigateTab

Navigate an existing tab to a new URL.

Fields

tab_id: u32

The ID of the tab to navigate.

url: String

The URL to load in the tab.

CloseTab

Close a tab.

Fields

tab_id: u32

The ID of the tab to close.

PinTab

Pin a tab.

Fields

tab_id: u32

The ID of the tab to pin.

UnpinTab

Unpin a tab.

Fields

tab_id: u32

The ID of the tab to unpin.

WarmupTab

Warm up a discarded tab, loading its content into memory without activating it.

Fields

tab_id: u32

The ID of the tab to warm up.

MuteTab

Mute a tab, suppressing any audio it produces.

Fields

tab_id: u32

The ID of the tab to mute.

UnmuteTab

Unmute a tab, allowing it to produce audio again.

Fields

tab_id: u32

The ID of the tab to unmute.

MoveTab

Move a tab to a new position within its window.

Fields

tab_id: u32

The ID of the tab to move.

new_index: u32

The new zero-based index for the tab within its window.

GoBack

Navigate backward in a tab’s session history.

Returns a CliResult::Tab with the details of the page navigated to, or the current tab state if the history boundary was already reached.

Fields

tab_id: u32

The ID of the tab to navigate.

steps: u32

Number of steps to go back (default 1).

GoForward

Navigate forward in a tab’s session history.

Returns a CliResult::Tab with the details of the page navigated to, or the current tab state if the history boundary was already reached.

Fields

tab_id: u32

The ID of the tab to navigate.

steps: u32

Number of steps to go forward (default 1).

SubscribeEvents

Subscribe to a live stream of browser events.

After sending this command the mediator streams BrowserEvent objects as newline-delimited JSON on the same connection until the client disconnects. No CliResponse is sent; events arrive directly as BrowserEvent JSON.

Trait Implementations

impl Clone for CliCommand

fn clone(&self) -> CliCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CliCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CliCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CliCommand

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CliCommand

impl StructuralPartialEq for CliCommand