Enum Module 

pub enum Module {
    JsHardening,
    NavigationPolicy,
    WindowState,
    ShowOnReady,
    RevealOnReopen,
    Watchdog,
    Presence,
    Broker,
    Stream,
    Recovery,
    Frameless,
    Clipboard,
}

A shell module that can be opted out. The comments say what each one controls.

Variants

JsHardening

Injected DOM hardening script and native webview hardening (Hardening).

NavigationPolicy

Navigation and popup policy (NavPolicy, the external-link handler).

WindowState

Window geometry restore and persistence.

ShowOnReady

Show the main window once its webview is ready.

RevealOnReopen

Reveal the main window on a macOS Dock reopen (RunEvent::Reopen) and when the OS hands the app a URL or file (RunEvent::Opened). Off, neither shows, unminimises or focuses anything (the URL is still delivered). On in every set except where a host removes it.

Watchdog

The hang watchdog and its rightkit-shell://stall event.

Presence

The presence loop (fullscreen and meeting detection).

Broker

Path-broker commands (rk_shell_path_*).

Stream

Ranged custom schemes: the stream scheme and the site-root scheme, with their grant commands.

Recovery

Crash-safe setup recovery commands.

Frameless

Frameless chrome for windows opened through the shell, and traffic-light offsets.

Clipboard

Clipboard commands, including the typed rk_shell_clipboard_item.

Implementations

impl Module

pub const ALL: [Module; 12]

Every module, in declaration order.

pub const STATE: [Module; 5]

The modules install_state_only keeps.

pub const LIFECYCLE_OFF: [Module; 5]

The modules lifecycle_only turns off.

pub const LIFECYCLE_HOST_OPT_IN: [Module; 1]

Modules lifecycle_only leaves off by default because a lifecycle-only host owns its own windows: the host turns one back on explicitly (ShellBuilder::show_on_ready(true)).

pub fn name(self) -> &'static str

Stable snake_case name, used in diagnostics (rk_shell_status).

Trait Implementations

impl Clone for Module

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Module

impl Debug for Module

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

Formats the value using the given formatter.

impl Eq for Module

impl Hash for Module

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Module

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Module

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Module

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Module