Skip to main content

EnvironmentOptions

Struct EnvironmentOptions 

Source
pub struct EnvironmentOptions { /* private fields */ }
Expand description

Configures the WebView2 Environment, including the user data folder, the browser executable folder, additional browser command-line arguments, and the UI language. Build one with the fluent setters and pass it to Environment::with_options.

use windows_webview::EnvironmentOptions;

let options = EnvironmentOptions::new()
    .user_data_folder(r"C:\MyApp\WebView2")
    .additional_browser_arguments("--disable-features=msSmartScreenProtection")
    .language("en-US");

Implementations§

Source§

impl EnvironmentOptions

Source

pub fn new() -> Self

Creates options with all WebView2 defaults.

Source

pub fn browser_executable_folder(self, value: impl Into<String>) -> Self

Sets the folder containing the WebView2 browser (Edge) binaries to use instead of the installed runtime.

Source

pub fn user_data_folder(self, value: impl Into<String>) -> Self

Sets the folder where WebView2 stores its user data (cache, cookies, …).

Source

pub fn additional_browser_arguments(self, value: impl Into<String>) -> Self

Sets additional command-line arguments passed to the browser process.

Source

pub fn language(self, value: impl Into<String>) -> Self

Sets the default display language (for example "en-US").

Source

pub fn target_compatible_browser_version(self, value: impl Into<String>) -> Self

Sets the minimum compatible browser version the environment requires.

When unset, the environment uses the WebView2 GA baseline (86.0.616.0), which every supported runtime satisfies.

Source

pub fn allow_single_sign_on_using_os_primary_account(self, value: bool) -> Self

Enables single sign-on using the operating system’s primary account.

Source

pub fn are_browser_extensions_enabled(self, value: bool) -> Self

Enables loading and running browser extensions in the environment.

Source

pub fn scrollbar_style(self, value: ScrollBarStyle) -> Self

Sets the scrollbar style pages render with.

Trait Implementations§

Source§

impl Clone for EnvironmentOptions

Source§

fn clone(&self) -> EnvironmentOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EnvironmentOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EnvironmentOptions

Source§

fn default() -> EnvironmentOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.