Struct StartRequest

pub struct StartRequest {

    pub browser_profile_id: usize,
    pub os: Os,
    pub versions: Versions,
    pub automation: bool,
    pub headless: bool,
    pub imageless: bool,
    pub use_action_synchronizator: bool,
    pub action_synchronizator_session_name: Option<String>,
    pub action_synchronizator_is_owned: Option<bool>,
    pub scenum_custom_mode: bool,
    pub for_scenario: bool,
    pub use_mock_profile: bool,
    pub user_screen_width: u16,
    pub user_screen_height: u16,
    pub connection_info: ConnectionInfo,
    pub dolphin_integration_token: Option<String>,
    pub remote_api_base_url: String,
    pub paths: UserPaths,
    pub logging_level: LoggingLevel,
    pub browser_down_port: u16,
    pub present_datadir_hash: Option<String>,
}

Request structure for starting a browser profile.

Fields

browser_profile_id: usize

Unique identifier of the browser profile to start

os: Os

Platform that user is running our software on

versions: Versions

Version information for various components

automation: bool

Whether to enable automation mode

headless: bool

Whether to run browser in headless mode (no GUI)

imageless: bool

Whether to disable images loading

use_action_synchronizator: bool

Whether to use action synchronization between browser profiles

action_synchronizator_session_name: Option<String>

Name of the session to synchronize with. Required if use_action_synchronizator is true.

action_synchronizator_is_owned: Option<bool>

Whether this profile owns the synchronization session (so the profile is master).

scenum_custom_mode: bool

Whether to enable custom mode for scenario execution

for_scenario: bool

For scenario constructor. Implies that user may use mock profile (or may not, so be cautious).

use_mock_profile: bool

Whether to use a mock profile instead of a real one

user_screen_width: u16

Width of the user’s screen in pixels

user_screen_height: u16

Height of the user’s screen in pixels

connection_info: ConnectionInfo

Connection and geolocation information

dolphin_integration_token: Option<String>

Optional token for Dolphin integration

remote_api_base_url: String

Base URL for remote API calls

paths: UserPaths

File system paths configuration

logging_level: LoggingLevel

Logging verbosity level

browser_down_port: u16

Port number for browser download operations

present_datadir_hash: Option<String>

Hash of the present datadir. If provided, we may send the diff url alongside the whole datadir url.

Implementations

impl StartRequest

pub fn get_mock() -> Self

Creates a mock start request for testing purposes.

Trait Implementations

impl Clone for StartRequest

fn clone(&self) -> StartRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StartRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StartRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for StartRequest

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for StartRequest

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>