Skip to main content

Application

Struct Application 

Source
pub struct Application(/* private fields */);
Expand description

A reference to a GPUI application, typically constructed in the main function of your app. You won’t interact with this type much outside of initial configuration and startup.

Implementations§

Source§

impl Application

Represents an application before it is fully launched. Once your app is configured, you’ll start the app with App::run.

Source

pub fn with_platform(platform: Rc<dyn Platform>) -> Application

Builds an app with a caller-provided platform implementation.

Source

pub fn new_inaccessible(platform: Rc<dyn Platform>) -> Application

Builds an app with accessibility (AccessKit) integration forcibly disabled.

In this mode, accessibility APIs (e.g. div().role()) silently no-op.

See the accessibility guide for an overview of the features this disables.

Source

pub fn with_assets(self, asset_source: impl AssetSource) -> Application

Assigns the source of assets for the application.

Source

pub fn with_restart_arguments(self, arguments: Vec<OsString>) -> Application

Configures arguments to pass when restarting the application.

Source

pub fn with_http_client(self, http_client: Arc<dyn HttpClient>) -> Application

Sets the HTTP client for the application.

Source

pub fn with_quit_mode(self, mode: QuitMode) -> Application

Configures when the application should automatically quit. By default, QuitMode::Default is used.

Source

pub fn run<F>(self, on_finish_launching: F)
where F: 'static + FnOnce(&mut App),

Start the application. The provided callback will be called once the app is fully launched.

Source

pub fn run_embedded<F>(self, on_finish_launching: F) -> ApplicationHandle
where F: 'static + FnOnce(&mut App),

Start the application for an embedder that drives the run loop itself.

On ordinary platforms Platform::run blocks for the lifetime of the app, and the app state is kept alive by Application::run’s stack frame. Embedded platforms — where the run loop belongs to someone else, e.g. GPUI compiled into a Wasm guest, or a GPUI view hosted inside a foreign native application — implement Platform::run to invoke the launch callback and return immediately. This method supports that shape: it returns an ApplicationHandle that keeps the app alive and lets the embedder re-enter it whenever the external run loop yields control.

Source

pub fn on_open_urls<F>(&self, callback: F) -> &Application
where F: 'static + FnMut(Vec<String>),

Register a handler to be invoked when the platform instructs the application to open one or more URLs.

Source

pub fn on_reopen<F>(&self, callback: F) -> &Application
where F: 'static + FnMut(&mut App),

Invokes a handler when an already-running application is launched. On macOS, this can occur when the application icon is double-clicked or the app is launched via the dock.

Source

pub fn background_executor(&self) -> BackgroundExecutor

Returns a handle to the BackgroundExecutor associated with this app, which can be used to spawn futures in the background.

Source

pub fn foreground_executor(&self) -> ForegroundExecutor

Returns a handle to the ForegroundExecutor associated with this app, which can be used to spawn futures in the foreground.

Source

pub fn text_system(&self) -> Arc<TextSystem>

Returns a reference to the TextSystem associated with this app.

Source

pub fn path_for_auxiliary_executable( &self, name: &str, ) -> Result<PathBuf, Error>

Returns the file URL of the executable with the specified name in the application bundle

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

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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