Skip to main content

DesktopApp

Struct DesktopApp 

Source
pub struct DesktopApp<S: AppState, W: Widget<S>> { /* private fields */ }
Expand description

The desktop application shell that owns the window, event loop, and rendering pipeline.

Generic over S (the application state type) and W (the root widget type). Construct via DesktopApp::new() and configure with builder methods (with_title, with_state_init, with_key_handler, etc.) before calling run() to start the event loop.

Implementations§

Source§

impl<S: AppState + Default, W: Widget<S> + 'static> DesktopApp<S, W>

Source

pub fn new(root_widget: W) -> Self

Source

pub fn with_key_handler<F>(self, handler: F) -> Self
where F: Fn(&mut S, &KeyCode, u8) -> bool + Send + Sync + 'static,

Source

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

Source

pub fn with_state_init<F>(self, init: F) -> Self
where F: FnOnce(&mut S),

Mutate the initial application state before the first frame.

Source

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

Source

pub fn with_sync_env<F>(self, f: F) -> Self
where F: Fn(&S, &mut Env) + Send + Sync + 'static,

Source

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.

Source

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

Register a handler for Effect::App(payload) effects.

The handler runs on the calling thread and should spawn its own background work if needed, sending results through the provided mpsc::Sender<EffectResult>.

Source

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

Source

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

Source

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

Auto Trait Implementations§

§

impl<S, W> Freeze for DesktopApp<S, W>
where W: Freeze,

§

impl<S, W> !RefUnwindSafe for DesktopApp<S, W>

§

impl<S, W> Send for DesktopApp<S, W>
where W: Send,

§

impl<S, W> !Sync for DesktopApp<S, W>

§

impl<S, W> Unpin for DesktopApp<S, W>
where W: Unpin, S: Unpin,

§

impl<S, W> UnsafeUnpin for DesktopApp<S, W>
where W: UnsafeUnpin,

§

impl<S, W> !UnwindSafe for DesktopApp<S, W>

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<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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,