Docs.rs
  • tauri-runtime-2.0.0-rc.6
    • tauri-runtime 2.0.0-rc.6
    • Docs.rs crate page
    • Apache-2.0 OR MIT
    • Links
    • Homepage
    • Repository
    • crates.io
    • Source
    • Owners
    • tauri-bot
    • Dependencies
      • dpi ^0.1 normal
      • http ^1.1 normal
      • raw-window-handle ^0.6 normal
      • serde ^1.0 normal
      • serde_json ^1.0 normal
      • tauri-utils ^2.0.0-rc.6 normal
      • thiserror ^1.0 normal
      • url ^2 normal
      • gtk ^0.18 normal
      • jni ^0.21 normal
      • url ^2 normal
      • windows ^0.58 normal
    • Versions
    • 77.89% of the crate is documented
  • Go to latest stable release
  • Platform
    • x86_64-apple-darwin
    • x86_64-apple-ios
    • x86_64-linux-android
    • x86_64-pc-windows-msvc
    • x86_64-unknown-linux-gnu
  • Feature flags
  • Rust
    • About docs.rs
    • Privacy policy
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate tauri_runtime

logo

tauri_runtime2.0.0-rc.6

  • All Items
  • Re-exports
  • Modules
  • Structs
  • Enums
  • Traits
  • Type Aliases
?
Settings

Crate tauri_runtime

source ·
Expand description

Internal runtime between Tauri and the underlying webview runtime.

None of the exposed API of this crate is stable, and it may break semver compatibility in the future. The major version only signifies the intended Tauri version.

Re-exports§

  • pub use dpi;

Modules§

  • monitor
    Types useful for interacting with a user’s monitors.
  • webview
    A layer between raw Runtime webviews and Tauri.
  • window
    A layer between raw Runtime windows and Tauri.

Structs§

  • Icon
    Window icon.
  • ProgressBarState
    Progress Bar State
  • Rect
    A rectangular region.
  • RuntimeInitArgs

Enums§

  • DeviceEventFilter
  • Error
  • ExitRequestedEventAction
    Action to take when the event loop is about to exit
  • ProgressBarStatus
    Progress bar status.
  • ResizeDirection
    Defines the orientation that a window resize will be performed.
  • RunEvent
    Event triggered on the event loop run.
  • UserAttentionType
    Type of user attention requested on a window.

Traits§

  • EventLoopProxy
  • Runtime
    The webview runtime interface.
  • RuntimeHandle
    A Send handle to the runtime.
  • UserEvent
    A type that can be used as an user event.
  • WebviewDispatch
    Webview dispatcher. A thread-safe handle to the webview APIs.
  • WindowDispatch
    Window dispatcher. A thread-safe handle to the window APIs.

Type Aliases§

  • Result
    Result type.
  • WebviewEventId
  • WindowEventId

Results

Type "windowbuilderbase" not found. Showing results for closest type name "windowbuilder" instead.

trait
tauri_runtime::window::WindowBuilderBase
Do NOT implement this trait except for use in a custom …
trait
tauri_runtime::window::WindowBuilder
A builder for all attributes related to a single window.
assoc type
tauri_runtime::WindowDispatch::WindowBuilder
The window builder type.
struct field
tauri_runtime::window::PendingWindow::window_builder
The WindowBuilder that the window will be created with.
trait method
tauri_runtime::window::WindowBuilder::center
Show window in the center of the screen.
trait method
tauri_runtime::window::WindowBuilder::owner
Set an owner to the window to be created.
trait method
tauri_runtime::window::WindowBuilder::parent
Sets a parent to the window to be created.
trait method
tauri_runtime::window::WindowBuilder::shadow
Sets whether or not the window has shadow.
trait method
tauri_runtime::window::WindowBuilder::focused
Whether the window will be initially focused or not.
trait method
tauri_runtime::window::WindowBuilder::visible
Whether the window should be immediately visible upon …
trait method
tauri_runtime::window::WindowBuilder::closable
Whether the window’s native close button is enabled or …
trait method
tauri_runtime::window::WindowBuilder::position
The initial position of the window’s.
trait method
tauri_runtime::window::WindowBuilder::maximized
Whether the window should be maximized upon creation.
trait method
tauri_runtime::window::WindowBuilder::resizable
Whether the window is resizable or not. When resizable is …
trait method
tauri_runtime::window::WindowBuilder::fullscreen
Whether to start the window in fullscreen or not.
trait method
tauri_runtime::window::WindowBuilder::inner_size
Window size.
trait method
tauri_runtime::window::WindowBuilder::decorations
Whether the window should have borders and bars.
trait method
tauri_runtime::window::WindowBuilder::maximizable
Whether the window’s native maximize button is enabled …
trait method
tauri_runtime::window::WindowBuilder::minimizable
Whether the window’s native minimize button is enabled …
trait method
tauri_runtime::window::WindowBuilder::transparent
Whether the window should be transparent. If this is true, …
trait method
tauri_runtime::window::WindowBuilder::skip_taskbar
Sets whether or not the window icon should be added to the …
trait method
tauri_runtime::window::WindowBuilder::always_on_top
Whether the window should always be on top of other …
trait method
tauri_runtime::window::WindowBuilder::drag_and_drop
Enables or disables drag and drop support.
trait method
tauri_runtime::window::WindowBuilder::max_inner_size
Window max inner size.
trait method
tauri_runtime::window::WindowBuilder::min_inner_size
Window min inner size.
trait method
tauri_runtime::window::WindowBuilder::always_on_bottom
Whether the window should always be below other windows.
trait method
tauri_runtime::window::WindowBuilder::content_protected
Prevents the window contents from being captured by other …
trait method
tauri_runtime::window::WindowBuilder::inner_size_constraints
Window inner size constraints.
trait method
tauri_runtime::window::WindowBuilder::visible_on_all_workspaces
Whether the window should be visible on all workspaces or …
trait method
tauri_runtime::window::WindowBuilder::icon
Sets the window icon.
trait method
tauri_runtime::window::WindowBuilder::theme
Forces a theme or uses the system settings if None was …
trait method
tauri_runtime::window::WindowBuilder::has_icon
Whether the icon was set or not.
trait method
tauri_runtime::window::WindowBuilder::title
The title of the window in the title bar.
trait method
tauri_runtime::window::WindowBuilder::get_theme
trait method
tauri_runtime::WindowDispatch::hide
Hides the window.
trait method
tauri_runtime::WindowDispatch::show
Shows the window.
trait method
tauri_runtime::WindowDispatch::close
Closes the window.
trait method
tauri_runtime::WindowDispatch::theme
Returns the current window theme.
trait method
tauri_runtime::WindowDispatch::title
Gets the window’s current title.
trait method
tauri_runtime::WindowDispatch::center
Centers the window.
trait method
tauri_runtime::WindowDispatch::destroy
Destroys the window.
trait method
tauri_runtime::WindowDispatch::maximize
Maximizes the window.
trait method
tauri_runtime::WindowDispatch::minimize
Minimizes the window.
trait method
tauri_runtime::WindowDispatch::set_focus
Bring the window to front and focus.
trait method
tauri_runtime::WindowDispatch::is_focused
Gets the window’s current focus state.
trait method
tauri_runtime::WindowDispatch::is_visible
Gets the window’s current visibility state.
trait method
tauri_runtime::WindowDispatch::unmaximize
Unmaximizes the window.
trait method
tauri_runtime::WindowDispatch::unminimize
Unminimizes the window.
trait method
tauri_runtime::WindowDispatch::is_closable
Gets the window’s native close button state.
trait method
tauri_runtime::WindowDispatch::is_decorated
Gets the window’s current decoration state.
trait method
tauri_runtime::WindowDispatch::is_maximized
Gets the window’s current maximized state.
trait method
tauri_runtime::WindowDispatch::is_minimized
Gets the window’s current minimized state.
trait method
tauri_runtime::WindowDispatch::is_resizable
Gets the window’s current resizable state.
trait method
tauri_runtime::WindowDispatch::scale_factor
Returns the scale factor that can be used to map logical …
trait method
tauri_runtime::WindowDispatch::is_fullscreen
Gets the window’s current fullscreen state.
trait method
tauri_runtime::WindowDispatch::is_maximizable
Gets the window’s native maximize button state.
trait method
tauri_runtime::WindowDispatch::is_minimizable
Gets the window’s native minimize button state.
trait method
tauri_runtime::WindowDispatch::start_dragging
Starts dragging the window.
trait method
tauri_runtime::WindowDispatch::set_icon
Updates the window icon.
trait method
tauri_runtime::WindowDispatch::set_size
Resizes the window.
trait method
tauri_runtime::WindowDispatch::inner_size
Returns the physical size of the window’s client area.
trait method
tauri_runtime::WindowDispatch::outer_size
Returns the physical size of the entire window.
trait method
tauri_runtime::WindowDispatch::set_shadow
Updates the shadow flag.
trait method
tauri_runtime::WindowDispatch::set_closable
Updates the window’s native close button state.
trait method
tauri_runtime::WindowDispatch::set_position
Updates the window position.
trait method
tauri_runtime::WindowDispatch::set_resizable
Updates the window resizable flag.
trait method
tauri_runtime::WindowDispatch::window_handle
Raw window handle.
trait method
tauri_runtime::WindowDispatch::inner_position
Returns the position of the top-left hand corner of the …
trait method
tauri_runtime::WindowDispatch::outer_position
Returns the position of the top-left hand corner of the …
trait method
tauri_runtime::WindowDispatch::set_fullscreen
Updates the window fullscreen state.
trait method
tauri_runtime::WindowDispatch::current_monitor
Returns the monitor on which the window currently resides.
trait method
tauri_runtime::WindowDispatch::primary_monitor
Returns the primary monitor of the system.
trait method
tauri_runtime::WindowDispatch::set_cursor_grab
Grabs the cursor, preventing it from leaving the window.
trait method
tauri_runtime::WindowDispatch::set_cursor_icon
trait method
tauri_runtime::WindowDispatch::set_decorations
Updates the decorations flag.
trait method
tauri_runtime::WindowDispatch::set_maximizable
Updates the window’s native maximize button state.
trait method
tauri_runtime::WindowDispatch::set_minimizable
Updates the window’s native minimize button state.
trait method
tauri_runtime::WindowDispatch::set_progress_bar
Sets the taskbar progress state.
trait method
tauri_runtime::WindowDispatch::set_skip_taskbar
Whether to hide the window icon from the taskbar or not.
trait method
tauri_runtime::WindowDispatch::set_always_on_top
Updates the window alwaysOnTop flag.
trait method
tauri_runtime::WindowDispatch::available_monitors
Returns the list of all the monitors available on the …
trait method
tauri_runtime::WindowDispatch::set_cursor_visible
Modifies the cursor’s visibility.
trait method
tauri_runtime::WindowDispatch::set_title_bar_style
Sets the title bar style. Available on macOS only.
trait method
tauri_runtime::WindowDispatch::set_always_on_bottom
Updates the window alwaysOnBottom flag.
trait method
tauri_runtime::WindowDispatch::set_size_constraints
Sets this window’s minimum inner width.
trait method
tauri_runtime::WindowDispatch::set_content_protected
Prevents the window contents from being captured by other …
trait method
tauri_runtime::WindowDispatch::start_resize_dragging
Starts resize-dragging the window.
trait method
tauri_runtime::WindowDispatch::set_ignore_cursor_events
Ignores the window cursor events.
trait method
tauri_runtime::WindowDispatch::set_visible_on_all_workspaces
Updates the window visibleOnAllWorkspaces flag.
trait method
tauri_runtime::WindowDispatch::set_max_size
Updates the window max inner size.
trait method
tauri_runtime::WindowDispatch::set_min_size
Updates the window min inner size.
trait method
tauri_runtime::WindowDispatch::create_webview
Create a new webview.
trait method
tauri_runtime::WindowDispatch::monitor_from_point
Returns the monitor that contains the given point.
trait method
tauri_runtime::WindowDispatch::request_user_attention
Requests user attention to the window.
trait method
tauri_runtime::WindowDispatch::set_title
Updates the window title.
trait method
tauri_runtime::WindowDispatch::on_window_event
Registers a window event handler.
trait method
tauri_runtime::WindowDispatch::run_on_main_thread
Run a task on the main thread.
trait method
tauri_runtime::WindowDispatch::set_cursor_position
Changes the position of the cursor in window coordinates.
trait method
tauri_runtime::WindowDispatch::create_window
Create a new window.
trait method
tauri_runtime::window::WindowBuilder::new
Initializes a new window attributes builder.
trait method
tauri_runtime::window::WindowBuilder::center
Show window in the center of the screen.
trait method
tauri_runtime::window::WindowBuilder::owner
Set an owner to the window to be created.
trait method
tauri_runtime::window::WindowBuilder::parent
Sets a parent to the window to be created.
trait method
tauri_runtime::window::WindowBuilder::shadow
Sets whether or not the window has shadow.
trait method
tauri_runtime::window::WindowBuilder::focused
Whether the window will be initially focused or not.
trait method
tauri_runtime::window::WindowBuilder::visible
Whether the window should be immediately visible upon …
trait method
tauri_runtime::window::WindowBuilder::closable
Whether the window’s native close button is enabled or …
trait method
tauri_runtime::window::WindowBuilder::position
The initial position of the window’s.
trait method
tauri_runtime::window::WindowBuilder::maximized
Whether the window should be maximized upon creation.
trait method
tauri_runtime::window::WindowBuilder::resizable
Whether the window is resizable or not. When resizable is …
trait method
tauri_runtime::window::WindowBuilder::fullscreen
Whether to start the window in fullscreen or not.
trait method
tauri_runtime::window::WindowBuilder::inner_size
Window size.
trait method
tauri_runtime::window::WindowBuilder::decorations
Whether the window should have borders and bars.
trait method
tauri_runtime::window::WindowBuilder::maximizable
Whether the window’s native maximize button is enabled …
trait method
tauri_runtime::window::WindowBuilder::minimizable
Whether the window’s native minimize button is enabled …
trait method
tauri_runtime::window::WindowBuilder::transparent
Whether the window should be transparent. If this is true, …
trait method
tauri_runtime::window::WindowBuilder::skip_taskbar
Sets whether or not the window icon should be added to the …
trait method
tauri_runtime::window::WindowBuilder::always_on_top
Whether the window should always be on top of other …
trait method
tauri_runtime::window::WindowBuilder::drag_and_drop
Enables or disables drag and drop support.
trait method
tauri_runtime::window::WindowBuilder::max_inner_size
Window max inner size.
trait method
tauri_runtime::window::WindowBuilder::min_inner_size
Window min inner size.
trait method
tauri_runtime::window::WindowBuilder::always_on_bottom
Whether the window should always be below other windows.
trait method
tauri_runtime::window::WindowBuilder::content_protected
Prevents the window contents from being captured by other …
trait method
tauri_runtime::window::WindowBuilder::inner_size_constraints
Window inner size constraints.
trait method
tauri_runtime::window::WindowBuilder::visible_on_all_workspaces
Whether the window should be visible on all workspaces or …
trait method
tauri_runtime::window::WindowBuilder::icon
Sets the window icon.
trait method
tauri_runtime::window::WindowBuilder::theme
Forces a theme or uses the system settings if None was …
trait method
tauri_runtime::window::WindowBuilder::with_config
Initializes a new window builder from a WindowConfig
trait method
tauri_runtime::window::WindowBuilder::title
The title of the window in the title bar.