Struct WinitApp 

pub struct WinitApp<S: GlobalState, W>
where
    W: Clone + Into<Widget>,
{ /* private fields */ }

Implementations

impl<S, W> WinitApp<S, W>

where S: GlobalState + Default, W: Clone + Into<Widget> + 'static,

pub fn new(root_widget: W) -> Self

pub fn new_with_global_state(root_widget: W, global_state: S) -> Self

pub fn with_global_state(self, global_state: S) -> Self

pub fn with_key_handler<F>(self, handler: F) -> Self

where F: Fn(&mut S, &KeyCode, u8) -> bool + Send + Sync + 'static,

pub fn with_title(self, title: impl Into<String>) -> Self

pub fn with_test_control_port(self, port: u16) -> Self

pub fn with_mount_selector(self, selector: impl Into<String>) -> Self

pub fn with_state_init<F>(self, init: F) -> Self

where F: FnOnce(&mut S),

Mutate the initial application state before the first frame.

pub fn with_env(self, env: Env) -> Self

pub fn with_design_system<D: DesignSystem>(self, mode: DesignMode) -> Self

pub fn with_sync_env<F>(self, f: F) -> Self

where F: Fn(&S, &mut Env) + Send + Sync + 'static,

pub fn with_frame_hook<F>(self, f: F) -> Self

where F: Fn(&mut S) -> bool + Send + Sync + 'static,

Register a hook that runs on every AboutToWait event with mutable access to the application state. Return true to request a redraw. Useful for polling background services (e.g. LSP) between key events.

pub fn with_async<F>(self, configure: F) -> Self

where F: FnOnce(&mut AsyncRegistry),

pub fn with_notification_host<H>(self, host: H) -> Self

where H: NotificationHost,

Registers the host implementation used for notification effects.

host receives requests emitted by ctx.effects.notifications(). Use this to install a real OS/browser notification provider in a shell, or a deterministic memory provider in tests.

pub fn with_nfc_host<H>(self, host: H) -> Self

where H: NfcHost,

Registers the host implementation used for NFC effects.

host owns scanning, writing, emulation, and cancellation. Install a provider only for targets or attached reader hardware that can satisfy the NFC contract.

pub fn with_biometric_host<H>(self, host: H) -> Self

where H: BiometricHost,

Registers the host implementation used for biometric authentication effects.

host should map Fission requests to the platform local-authentication system and return typed errors for missing enrollment, cancellation, or unsupported hardware.

pub fn with_passkey_host<H>(self, host: H) -> Self

where H: PasskeyHost,

Registers the host implementation used for passkey/WebAuthn effects.

host should map Fission registration and authentication requests to the platform credential APIs and return WebAuthn data for server-side verification. It should not treat local biometric unlock as proof of identity without server verification.

pub fn with_bluetooth_host<H>(self, host: H) -> Self

where H: BluetoothHost,

Registers the host implementation used for Bluetooth effects.

host owns adapter state, permission, scanning, connecting, reads, writes, and advertising. Use this boundary to keep platform Bluetooth APIs out of shared app reducers.

pub fn with_barcode_scanner_host<H>(self, host: H) -> Self

where H: BarcodeScannerHost,

Registers the host implementation used for barcode scanner effects.

host may run live camera scanning, decode supplied image bytes, or both. Reducers should rely on this provider instead of depending on a specific camera or decoder library.

pub fn with_camera_host<H>(self, host: H) -> Self

where H: CameraHost,

Registers the host implementation used for camera and flashlight effects.

host owns camera availability, permission, photo capture, torch control, and cancellation. Use memory hosts for tests and real OS providers for production shells.

pub fn with_clipboard_host<H>(self, host: H) -> Self

where H: ClipboardHost,

Registers the host implementation used for clipboard effects.

host owns text and typed clipboard access. This is useful for tests, custom shells, or platforms where clipboard behavior differs from the default desktop provider.

pub fn with_geolocation_host<H>(self, host: H) -> Self

where H: GeolocationHost,

Registers the host implementation used for geolocation effects.

host owns permission checks and current-position requests. It should map Fission accuracy and cache controls to the platform location service where available.

pub fn with_haptic_host<H>(self, host: H) -> Self

where H: HapticHost,

Registers the host implementation used for haptic feedback effects.

host owns impact, notification, selection, and pattern playback. It should return unsupported errors on devices without tactile hardware.

pub fn with_microphone_host<H>(self, host: H) -> Self

where H: MicrophoneHost,

Registers the host implementation used for microphone effects.

host owns input-device availability, permission, bounded recording, and cancellation. Keep recording code behind this provider boundary.

pub fn with_wifi_host<H>(self, host: H) -> Self

where H: WifiHost,

Registers the host implementation used for Wi-Fi effects.

host owns adapter availability, permission, scanning, connection, and disconnection. Platform Wi-Fi APIs are permission-sensitive, so unsupported and denied states should be reported explicitly.

pub fn with_volume_host<H>(self, host: H) -> Self

where H: VolumeHost,

Registers the host implementation used for volume-control effects.

host maps Fission volume streams to the platform mixer or media control model. It should return unsupported errors when the target cannot expose system volume control to apps.

pub fn with_startup_action<A: Action>(self, action: A) -> Self

pub fn with_deep_link_config(self, config: DeepLinkConfig) -> Self

Installs the deep-link filter used by this shell.

config declares accepted schemes, domains, and path prefixes. The shell uses it to classify inbound links before dispatching DeepLinkReceived actions into the app.

pub fn with_deep_link_scheme(self, scheme: impl Into<String>) -> Self

Adds one accepted custom deep-link scheme.

scheme is normalized by DeepLinkConfig. Use this for app-specific routes such as myapp://item/123.

pub fn with_deep_link_domain(self, domain: impl Into<String>) -> Self

Adds one accepted HTTP or HTTPS deep-link domain.

domain is normalized by DeepLinkConfig. Use this for verified app links, universal links, or web URLs that should enter the app.

pub fn with_startup_deep_link(self, link: DeepLink) -> Self

Queues a deep link to dispatch after the app starts.

Use this from host startup code when the platform launched the app because of an external URL. The link is delivered through the normal action path.

pub fn with_startup_notification_response( self, response: NotificationResponse, ) -> Self

Queues a notification response to dispatch after the app starts.

Use this when a notification action or tap launched the app. The response is delivered as NotificationResponseReceived through the normal reducer path.

pub fn on_deep_link<H>(self, handler: H) -> Self

where H: IntoHandler<S, DeepLinkReceived> + Send + Sync + 'static,

Registers a reducer handler for inbound deep links.

handler receives DeepLinkReceived actions from startup links and runtime host events. Use it to update routing state rather than parsing deep links inside widgets.

pub fn on_notification_response<H>(self, handler: H) -> Self

where H: IntoHandler<S, NotificationResponseReceived> + Send + Sync + 'static,

Registers a reducer handler for notification responses.

handler receives NotificationResponseReceived actions when the user taps or acts on a notification. Use it to route the user or process action ids in normal app state.

pub fn register_reducer( &mut self, action_id: ActionId, reducer: Reducer<S>, ) -> Result<()>

pub fn absorb_registry(&mut self, registry: ActionRegistry<S>)

pub fn run(self) -> Result<()>