Struct GuiApiLight 

pub struct GuiApiLight<P: CheckedPermissions> { /* private fields */ }

Reduced GUI API, usable by non-gui daemons

Implementations

impl<P: CheckedPermissions> GuiApiLight<P>

pub fn show_modal( &self, app_id: AppId, modal_style: ModalStyle, args: &[u8], ) -> Result<NavigationResult, GuiServerError>

where P: MessageAllowed<ShowModal>,

Permission: os/gui-server / ShowModal

Groups: ui-and-input.app-surface

Sender policy: signed

Grant timing: install-review

Shows a modal of the app, giving it a navigation object

pub fn navigate_to( &self, app_id: AppId, args: &[u8], ) -> Result<NavigationResult, GuiServerError>

where P: MessageAllowed<NavigateTo>,

Permission: os/gui-server / NavigateTo

Groups: ui-and-input.navigation

Sender policy: signed

Grant timing: install-review

pub fn run_app(&self, app_id: AppId) -> Result<RunAppResponse, GuiServerError>

where P: MessageAllowed<RunApp>,

Permission: os/gui-server / RunApp

Groups: ui-and-input.privileged-navigation

Sender policy: static-server

Grant timing: policy-only

pub fn check_user_presence( &self, options: UserPresenceOptions, ) -> Result<Option<UserPresenceResult>, GuiServerError>

where P: MessageAllowed<NavigateTo>,

Permission: os/gui-server / NavigateTo

Groups: ui-and-input.navigation

Sender policy: signed

Grant timing: install-review

pub fn invoke_alert( &self, alert: InvokeAlert, ) -> Result<AlertResult, GuiServerError>

where P: MessageAllowed<ShowModal>,

Permission: os/gui-server / ShowModal

Groups: ui-and-input.app-surface

Sender policy: signed

Grant timing: install-review

impl<P: CheckedPermissions> GuiApiLight<P>

pub fn connect() -> Self

Permission: none

Blocking connect: waits until gui-server has registered its name. gui-server is a mandatory system service, so callers wait for it instead of timing out and failing.

pub fn switch_to( &self, next_pid: PID, x: usize, y: usize, ) -> Result<(), GuiServerError>

where P: MessageAllowed<SwitchTo>,

Permission: os/gui-server / SwitchTo

Groups: ui-and-input.navigation

Sender policy: signed

Grant timing: install-review

Switches the focus to the app window of the given PID and the app zoom-in start position. Used by the app launcher, app switcher, and usb-debug protocol.

pub fn switch_to_launcher(&self) -> Result<bool, GuiServerError>

where P: MessageAllowed<SwitchToLauncher>,

Permission: os/gui-server / SwitchToLauncher

Groups: ui-and-input.navigation

Sender policy: signed

Grant timing: install-review

Switches the focus to the launcher app window. Used by apps.

pub fn is_locked(&self) -> Result<bool, GuiServerError>

where P: MessageAllowed<IsLocked>,

Permission: os/gui-server / IsLocked

Groups: TBD

Sender policy: TBD

Grant timing: TBD

pub fn shutdown(&self) -> Result<(), GuiServerError>

where P: MessageAllowed<Shutdown>,

Permission: os/gui-server / Shutdown

Groups: ui-and-input.capture-and-injection

Sender policy: static-server

Grant timing: policy-only

pub fn reboot(&self) -> Result<(), GuiServerError>

where P: MessageAllowed<Shutdown>,

Permission: os/gui-server / Shutdown

Groups: ui-and-input.capture-and-injection

Sender policy: static-server

Grant timing: policy-only

pub fn close_app(&self, pid: PID) -> Result<(), GuiServerError>

where P: MessageAllowed<CloseApp>,

Permission: os/gui-server / CloseApp

Groups: ui-and-input.navigation

Sender policy: signed

Grant timing: install-review

Closes the app window of the given PID. Used by the launcher, switcher, and usb-debug protocol to gracefully close apps.

pub fn capture_screen(&self) -> Result<DropDeallocate, GuiServerError>

where P: MessageAllowed<CaptureScreen>,

Permission: os/gui-server / CaptureScreen

Groups: ui-and-input.capture-and-injection

Sender policy: static-server

Grant timing: policy-only

Captures the current composited screen as raw pixel data. Returns a DropDeallocate of length FB_SIZE (SCREEN_WIDTH * SCREEN_HEIGHT * 4) that auto-unmaps on drop. Dereferences to MemoryRange / &[u8].

pub fn inject_touch(&self, touch: Touch) -> Result<(), GuiServerError>

where P: MessageAllowed<InjectTouch>,

Permission: os/gui-server / InjectTouch

Groups: ui-and-input.capture-and-injection

Sender policy: static-server

Grant timing: policy-only

Injects a touch event as if it came from the hardware touch controller.

pub fn inject_key( &self, is_pressed: bool, key: Key, ) -> Result<(), GuiServerError>

where P: MessageAllowed<InjectKey>,

Permission: os/gui-server / InjectKey

Groups: ui-and-input.capture-and-injection

Sender policy: static-server

Grant timing: policy-only

Injects a key press or release event into the active app.

pub fn inject_power_button( &self, is_pressed: bool, ) -> Result<(), GuiServerError>

where P: MessageAllowed<InjectPowerButton>,

Permission: os/gui-server / InjectPowerButton

Groups: TBD

Sender policy: TBD

Grant timing: TBD

Injects a power button press or release into gui-server’s power-button state machine.

pub fn update_kiosk_policy( &self, policy: UpdateKioskPolicy, ) -> Result<(), GuiServerError>

where P: MessageAllowed<UpdateKioskPolicy>,

Permission: os/gui-server / UpdateKioskPolicy

Groups: TBD

Sender policy: TBD

Grant timing: TBD

Trait Implementations

impl<P: Clone + CheckedPermissions> Clone for GuiApiLight<P>

fn clone(&self) -> GuiApiLight<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + CheckedPermissions> Debug for GuiApiLight<P>

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

Formats the value using the given formatter.

impl<P: Default + CheckedPermissions> Default for GuiApiLight<P>

fn default() -> GuiApiLight<P>

Returns the “default value” for a type.