Struct WebViewBuilder

pub struct WebViewBuilder<'a, T: 'a, I, C> {
    pub title: &'a str,
    pub content: Option<Content<C>>,
    pub width: i32,
    pub height: i32,
    pub resizable: bool,
    pub debug: bool,
    pub invoke_handler: Option<I>,
    pub user_data: Option<T>,
    pub frameless: bool,
}

Builder for constructing a WebView instance.

Example

extern crate web_view;

use web_view::*;

fn main() {
    WebViewBuilder::new()
        .title("Minimal webview example")
        .content(Content::Url("https://en.m.wikipedia.org/wiki/Main_Page"))
        .size(800, 600)
        .resizable(true)
        .debug(true)
        .user_data(())
        .invoke_handler(|_webview, _arg| Ok(()))
        .build()
        .unwrap()
        .run()
        .unwrap();
}

Fields

title: &'a str

content: Option<Content<C>>

width: i32

height: i32

resizable: bool

debug: bool

invoke_handler: Option<I>

user_data: Option<T>

frameless: bool

Implementations

impl<'a, T: 'a, I, C> WebViewBuilder<'a, T, I, C>

where I: FnMut(&mut WebView<'_, T>, &str) -> WVResult + 'a, C: AsRef<str>,

pub fn new() -> Self

Alias for WebViewBuilder::default().

pub fn title(self, title: &'a str) -> Self

Sets the title of the WebView window.

Defaults to "Application".

pub fn content(self, content: Content<C>) -> Self

Sets the content of the WebView. Either a URL or a HTML string.

pub fn size(self, width: i32, height: i32) -> Self

Sets the size of the WebView window.

Defaults to 800 x 600.

pub fn resizable(self, resizable: bool) -> Self

Sets the resizability of the WebView window. If set to false, the window cannot be resized.

Defaults to true.

pub fn debug(self, debug: bool) -> Self

Enables or disables debug mode.

Defaults to true for debug builds, false for release builds.

pub fn frameless(self, frameless: bool) -> Self

The window crated will be frameless

defaults to false

pub fn invoke_handler(self, invoke_handler: I) -> Self

Sets the invoke handler callback. This will be called when a message is received from JavaScript.

Errors

If the closure returns an Err, it will be returned on the next call to step().

pub fn user_data(self, user_data: T) -> Self

Sets the initial state of the user data. This is an arbitrary value stored on the WebView thread, accessible from dispatched closures without synchronization overhead.

pub fn build(self) -> WVResult<WebView<'a, T>>

Validates provided arguments and returns a new WebView if successful.

pub fn run(self) -> WVResult<T>

Validates provided arguments and runs a new WebView to completion, returning the user data.

Equivalent to build()?.run().

Trait Implementations

impl<'a, T: 'a, I, C> Default for WebViewBuilder<'a, T, I, C>

where I: FnMut(&mut WebView<'_, T>, &str) -> WVResult + 'a, C: AsRef<str>,

fn default() -> Self

Returns the “default value” for a type.