Skip to main content

RunOptions

Struct RunOptions 

Source
pub struct RunOptions {
    pub window_attributes: WindowAttributes,
    pub presentation_mode: PresentationMode,
    pub font_family: Option<FontFamily>,
    pub monospace_family: Option<FontFamily>,
    pub main_window: WindowKey,
    pub exit_policy: ExitPolicy,
    pub web: WebOptions,
    pub accessibility: bool,
}
Expand description

Native window configuration. Sizes in WindowAttributes may be logical or physical. On macOS the runner always enables system decorations for native controls and resizing.

window_attributes and presentation_mode describe the main window. Other windows use WindowOptions.

Fields§

§window_attributes: WindowAttributes§presentation_mode: PresentationMode§font_family: Option<FontFamily>

Replaces the bundled Inter family for every window. System fonts and color emoji still supply scripts the family lacks.

§monospace_family: Option<FontFamily>

Replaces the bundled JetBrains Mono used by monospace text, independently of font_family. Without the bundled-monospace feature and without this, monospace text uses the system’s generic monospace font.

§main_window: WindowKey

Key of the first window. Default: WindowKey::main.

§exit_policy: ExitPolicy

What closing the main window does. Default: ExitPolicy::MainWindow.

§web: WebOptions

Canvas and graphics API in a browser. Native runners ignore it.

§accessibility: bool

Serve an accessibility tree to assistive technology. Default: on. Nothing is built until a screen reader connects, so leaving it on costs nothing without one.

Implementations§

Source§

impl RunOptions

Source

pub fn with_font_family(self, family: FontFamily) -> Self

Use family for all text instead of the bundled Inter, without building a custom host around Context::with_fonts.

Source

pub fn with_monospace_family(self, family: FontFamily) -> Self

Use family for monospace text instead of the bundled JetBrains Mono.

Source

pub fn with_exit_policy(self, policy: ExitPolicy) -> Self

Choose whether the application ends with the main window or with the last window.

Source

pub fn with_accessibility(self, accessibility: bool) -> Self

Turn the accessibility integration off (or back on) for every window; see WindowOptions::with_accessibility for one window. Has no effect without the accesskit feature or in a browser, where there is no integration.

Source

pub fn with_main_window(self, key: impl Into<WindowKey>) -> Self

Name the main window, for applications that address it by a key of their own.

Source

pub fn with_canvas_id(self, id: impl Into<String>) -> Self

Draw on the <canvas id="..."> of the page instead of creating one. Browser only.

Source

pub fn with_container_id(self, id: impl Into<String>) -> Self

Put the canvas the runner creates into the element with this id and fill it, instead of covering the browser window. Browser only.

Source

pub fn with_web_backend(self, backend: WebBackend) -> Self

Choose WebGPU or WebGL2 in a browser. Browser only.

Source

pub fn with_rounded_corners(self, rounded: bool) -> Self

Request native rounded corners and the system shadow on Windows 11. Applies to undecorated windows as well. Maximized/snapped windows follow the OS policy. On other platforms this leaves window attributes unchanged. Call after setting window_attributes. Secondary windows choose their own with WindowOptions::with_rounded_corners.

Trait Implementations§

Source§

impl Clone for RunOptions

Source§

fn clone(&self) -> Self

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 RunOptions

Source§

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

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

impl Default for RunOptions

Source§

fn default() -> Self

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<T> Upcast<T> for T

Source§

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

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more