Struct WebContents

pub struct WebContents { /* private fields */ }

Docs: http://electronjs.org/docs/api/web-contents

Implementations

impl WebContents

pub fn from_id(id: usize) -> WebContents

impl WebContents

pub fn get_all_web_contents() -> Box<[JsValue]>

impl WebContents

pub fn get_focused_web_contents() -> WebContents

impl WebContents

pub fn add_work_space(&self, path: &str)

impl WebContents

pub fn begin_frame_subscription(&self, only_dirty: bool, callback: &Function)

impl WebContents

pub fn can_go_back(&self) -> bool

impl WebContents

pub fn can_go_forward(&self) -> bool

impl WebContents

pub fn can_go_to_offset(&self, offset: u32) -> bool

impl WebContents

pub fn capture_page(&self, rectangle: Option<Rectangle>) -> Promise

impl WebContents

pub fn clear_history(&self)

impl WebContents

pub fn close_dev_tools(&self)

impl WebContents

pub fn copy(&self)

impl WebContents

pub fn copy_image_at(&self, x: usize, y: usize)

impl WebContents

pub fn cut(&self)

impl WebContents

pub fn delete(&self)

impl WebContents

pub fn disable_device_emulation(&self)

impl WebContents

pub fn download_url(&self)

impl WebContents

pub fn enable_device_emulation(&self, options: EnableDeviceEmulationOptions)

impl WebContents

pub fn end_frame_subscription(&self)

impl WebContents

pub fn execute_java_script( &self, code: &str, user_gesture: Option<bool>, ) -> Promise

impl WebContents

pub fn execute_java_script_in_isolated_world( &self, world_id: u32, scripts: Box<[JsValue]>, user_gesture: Option<bool>, ) -> Promise

impl WebContents

pub fn find_in_page( &self, text: &str, options: Option<FindInPageOptions>, ) -> usize

impl WebContents

pub fn focus(&self)

impl WebContents

pub fn get_all_shared_workers(&self) -> Box<[JsValue]>

impl WebContents

pub fn get_os_process_id(&self) -> u32

impl WebContents

pub fn get_printers(&self)

impl WebContents

pub fn get_process_id(&self) -> u32

impl WebContents

pub fn get_title(&self) -> JsString

impl WebContents

pub fn get_type(&self) -> JsString

impl WebContents

pub fn get_url(&self) -> JsString

impl WebContents

pub fn get_web_rtc_ip_handling_policy(&self) -> JsString

impl WebContents

pub fn go_back(&self)

impl WebContents

pub fn go_forward(&self)

impl WebContents

pub fn go_to_index(&self, index: usize)

impl WebContents

pub fn go_to_offset(&self, index: usize)

impl WebContents

pub fn insert_css( &self, css: &str, options: Option<InsertCssOptions>, ) -> Promise

impl WebContents

pub fn insert_text(&self, text: &str) -> Promise

impl WebContents

pub fn inspect_element(&self, x: usize, y: usize)

impl WebContents

pub fn inspect_service_worker(&self)

impl WebContents

pub fn inspect_shared_worker(&self)

impl WebContents

pub fn inspect_shared_worker_by_id(&self, worker_id: &str)

impl WebContents

pub fn invalidate(&self)

impl WebContents

pub fn is_crashed(&self) -> bool

impl WebContents

pub fn is_currently_audible(&self) -> bool

impl WebContents

pub fn is_destroyed(&self) -> bool

impl WebContents

pub fn is_dev_tools_focused(&self) -> bool

impl WebContents

pub fn is_dev_tools_opened(&self) -> bool

impl WebContents

pub fn is_focused(&self) -> bool

impl WebContents

pub fn is_loading(&self) -> bool

impl WebContents

pub fn is_loading_main_frame(&self) -> bool

impl WebContents

pub fn is_offscreen(&self) -> bool

impl WebContents

pub fn is_painting(&self) -> bool

impl WebContents

pub fn is_waiting_for_response(&self) -> bool

impl WebContents

pub fn load_file( &self, file_path: &str, options: Option<LoadFileOptions>, ) -> Promise

impl WebContents

pub fn load_url(&self, url: &str, options: Option<LoadUrlOptions>) -> Promise

impl WebContents

pub fn open_dev_tools(&self, options: Option<OpenDevToolsOptions>)

impl WebContents

pub fn paste(&self)

impl WebContents

pub fn paste_and_match_style(&self)

impl WebContents

pub fn print( &self, options: Option<WebContentsPrintOptions>, callback: Option<&Function>, )

impl WebContents

pub fn print_to_pdf(&self, options: PrintToPdfOptions) -> Promise

impl WebContents

pub fn redo(&self)

impl WebContents

pub fn reload(&self)

impl WebContents

pub fn reload_ignoring_cache(&self)

impl WebContents

pub fn remove_inserted_css(&self, key: &str) -> Promise

impl WebContents

pub fn remove_work_space(&self, path: &str)

impl WebContents

pub fn replace(&self, text: &str)

impl WebContents

pub fn replaceMisspelling(&self, text: &str)

impl WebContents

pub fn save_page(&self, full_path: &str, save_type: &str) -> Promise

impl WebContents

pub fn select_all(&self)

impl WebContents

pub fn send(&self, channel: &str, args: Box<[JsValue]>)

impl WebContents

pub fn send_input_event(&self, input_event: &InputEvent)

impl WebContents

pub fn send_to_frame( &self, frame_id: usize, channel: &str, args: Box<[JsValue]>, )

impl WebContents

pub fn set_background_throttling(&self, allowed: bool)

impl WebContents

pub fn set_dev_tools_web_contents(&self, dev_tools_web_contents: &WebContents)

impl WebContents

pub fn set_ignore_menu_shortcuts(&self, ignore: bool)

impl WebContents

pub fn set_layout_zoom_level_limits(&self, min: f32, max: f32) -> Promise

impl WebContents

pub fn set_visual_zoom_level_limits(&self, min: f32, max: f32) -> Promise

impl WebContents

pub fn set_web_rtc_ip_handling_policy(&self, policy: &str)

impl WebContents

pub fn show_definition_for_selection(&self)

impl WebContents

pub fn start_drag(&self, item: Item)

impl WebContents

pub fn start_painting(&self)

impl WebContents

pub fn stop(&self)

impl WebContents

pub fn stop_finding_in_page(&self, action: &str)

impl WebContents

pub fn stop_painting(&self)

impl WebContents

pub fn take_heap_snapshot(&self)

impl WebContents

pub fn toggle_dev_tools(&self)

impl WebContents

pub fn undo(&self)

impl WebContents

pub fn unselect(&self)

impl WebContents

pub fn audio_muted(&self) -> bool

impl WebContents

pub fn set_audio_muted(&self, value: bool)

impl WebContents

pub fn debugger(&self) -> Debugger

impl WebContents

pub fn dev_tools_web_contents(&self) -> WebContents

impl WebContents

pub fn frame_rate(&self) -> f32

impl WebContents

pub fn set_frame_rate(&self, value: f32)

impl WebContents

pub fn host_web_contents(&self) -> WebContents

impl WebContents

pub fn id(&self) -> usize

impl WebContents

pub fn session(&self) -> Session

impl WebContents

pub fn user_agent(&self) -> JsString

impl WebContents

pub fn zoom_factor(&self) -> f32

impl WebContents

pub fn set_zoom_factor(&self, value: f32)

impl WebContents

pub fn zoom_level(&self) -> f32

impl WebContents

pub fn set_zoom_level(&self, value: f32)

Methods from Deref<Target = EventEmitter>

pub fn default_max_listeners(&self) -> f64

pub fn set_default_max_listeners(&self, value: f64)

pub fn add_listener( &self, event_name: &str, listener: &Function, ) -> EventEmitter

pub fn emit(&self, event_name: &str, args: Box<[JsValue]>) -> bool

pub fn event_names(&self) -> Box<[JsValue]>

pub fn get_max_listeners(&self)

pub fn listener_count(&self) -> f64

pub fn listeners(&self, event_name: &str) -> Box<[JsValue]>

pub fn off(&self, event_name: &str, listener: &Function) -> EventEmitter

pub fn on(&self, event_name: &str, listener: &Function) -> EventEmitter

pub fn once(&self, event_name: &str, listener: &Function) -> EventEmitter

pub fn prepend_listener( &self, event_name: &str, listener: &Function, ) -> EventEmitter

pub fn prepend_once_listener( &self, event_name: &str, listener: &Function, ) -> EventEmitter

pub fn remove_all_listeners(&self, event_name: Option<&str>) -> EventEmitter

pub fn remove_listener( &self, event_name: &str, listener: &Function, ) -> EventEmitter

pub fn set_max_listeners(&self, n: f64) -> EventEmitter

pub fn raw_listeners(&self, event_name: &str) -> Box<[JsValue]>

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into Wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<EventEmitter> for WebContents

fn as_ref(&self) -> &EventEmitter

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<JsValue> for WebContents

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<WebContents> for WebContents

fn as_ref(&self) -> &WebContents

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for WebContents

type Target = EventEmitter

The resulting type after dereferencing.

fn deref(&self) -> &EventEmitter

Dereferences the value.

impl From<JsValue> for WebContents

fn from(obj: JsValue) -> WebContents

Converts to this type from the input type.

impl From<WebContents> for EventEmitter

fn from(obj: WebContents) -> EventEmitter

Converts to this type from the input type.

impl From<WebContents> for JsValue

fn from(obj: WebContents) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for WebContents

type Abi = <JsValue as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a WebContents

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for WebContents

type Abi = <JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for WebContents

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for WebContents

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = WebContents

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for WebContents

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a WebContents

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for WebContents

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for WebContents

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<WebContents>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for WebContents

fn describe()