Struct zng_app::AppExtended

pub struct AppExtended<E: AppExtension> { /* private fields */ }

Expand description

Application builder.

You can use APP to start building the app.

Implementations§

impl AppExtended<Vec<Box<dyn AppExtensionBoxed>>>

pub fn extend<F: AppExtension>( self, extension: F ) -> AppExtended<Vec<Box<dyn AppExtensionBoxed>>>

Includes an application extension.

pub fn enable_device_events( self ) -> AppExtended<Vec<Box<dyn AppExtensionBoxed>>>

If the application should notify raw device events.

Device events are raw events not targeting any window, like a mouse move on any part of the screen. They tend to be high-volume events so there is a performance cost to activating this. Note that if this is false you still get the mouse move over windows of the app.

impl<E: AppExtension> AppExtended<E>

pub fn view_process_exe(self, view_process_exe: impl Into<PathBuf>) -> Self

Set the path to the executable for the View Process.

By the default the current executable is started again as a View Process, you can use two executables instead, by setting this value.

Note that the view_process_exe must start a view server and both executables must be build using the same exact VERSION.

pub fn run(self, start: impl Future<Output = ()> + Send + 'static)

Starts the app, then starts polling start to run.

This method only returns when the app has exited.

The start task runs in a UiTask in the app context, note that it only needs to start the app, usually by opening a window, the app will keep running after start is finished.

pub fn run_headless(self, with_renderer: bool) -> HeadlessApp

Initializes extensions in headless mode and returns an HeadlessApp.

If with_renderer is true spawns a renderer process for headless rendering. See HeadlessApp::renderer_enabled for more details.

Auto Trait Implementations§

impl<E> Freeze for AppExtended<E>
where E: Freeze,

impl<E> RefUnwindSafe for AppExtended<E>
where E: RefUnwindSafe,

impl<E> !Send for AppExtended<E>

impl<E> !Sync for AppExtended<E>

impl<E> Unpin for AppExtended<E>
where E: Unpin,

impl<E> UnwindSafe for AppExtended<E>
where E: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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