lucasfernog / webview2-rs

Rust bindings for the WebView2 COM APIs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

webview2-rs

Rust bindings for the WebView2 COM APIs

Crates in this repo

The root of this repo defines a virtual workspace in Cargo.toml which includes three crates:

Windows Metadata

The Windows crate requires a Windows Metadata (winmd) file describing the API. The one used in this repo was generated with the webview2-win32md project.

Getting started

Run all the tests from the root of the repo:

> cargo test

Or run the sample app from anywhere in the repo:

> cargo run --example sample

See the README.md in webview2-com for more details about using that crate in your own project.

Updating the WebView2 SDK

The webview2-com-sys build.rs script automatically downloads the NuGet package for the SDK and updates the static libs (WebView2LoaderStatic.lib) for each architecture under **/.windows/, if you build on a Windows machine. You can tell the build script to use a different version by updating WEBVIEW2_VERSION in build.rs:

    const WEBVIEW2_VERSION: &str = "1.0.1054.31";

It will also regenerate browser_version.rs and callback_interfaces.rs if they change in a new version. These two files are used in webview2-com, and in particular, the tests in callback.rs verify that all of the interfaces listed in callback_interfaces.rs are implemented. If a new version of the SDK declared additional callback interfaces, you will need to add those interfaces to callback.rs using the #[completed_callback] (for ICoreWebView2...CompletedHandler interfaces) and #[event_callback] (for ICoreWebView2...EventHandler interfaces) macros.

It does not regenerate the winmd file automatically because that would depend on having the dotnet CLI installed. New versions of the SDK should be backwards compatible, but you may want to regenerate the Microsoft.Web.WebView2.Win32.winmd file using webview2-win32md if you need functionality which was added in a new version.

The Windows crate looks in different locations for the .windows directory depending on whether you are building as part of the Cargo virtual workspace in the repo (shared workspace root) or publishing one of the sub-crates (manifest/crate directory). If you do regenerate the winmd file, you should update it in all 3 locations where it is referenced as part of the build:

  • ./.windows/winmd/Microsoft.Web.WebView2.Win32.winmd
  • ./crates/bindings/.windows/winmd/Microsoft.Web.WebView2.Win32.winmd
  • ./crates/webview2-com/.windows/winmd/Microsoft.Web.WebView2.Win32.winmd

About

Rust bindings for the WebView2 COM APIs

License:MIT License


Languages

Language:Rust 100.0%