Struct AppComponent 

pub struct AppComponent { /* private fields */ }

Real app content and its lifetime; hosts cannot extract an unbound root.

Implementations

impl AppComponent

pub fn take_replacement(&mut self) -> Option<ComponentReplacement>

The component the app built to show another record in this one’s place, once: the host closes this component and mounts that one.

pub const fn set_behaviour(&mut self, behaviour: ComponentBehaviour)

Set how the hosting window treats this component’s tree.

pub fn app_id(&self) -> &str

The id of the application this component is an instance of.

pub fn collaborate_through( &self, connector: HostSessionConnector, ) -> Option<CollaborationManager>

A collaboration manager for this component’s record, reached through the host’s connector as an app the host launched: what a host showing the component inside its own process hands the App it runs it in, so the component publishes and is invoked through the session broker as a launched app is. None when the component’s records have no route the broker could acknowledge.

pub fn register_document_history( &mut self, definition: &'static HistoryDefinition, ) -> Result<(), HistoryRegistrationError>

Register presentation for this component’s actual document custody. Every domain scope reads that record; external scopes retain their stated reason. This metadata carries no new authority and follows native/headless/tile mounts.

Errors

Refuses missing, stale or foreign document custody and invalid scope metadata.

pub fn register_document_and_file_history( &mut self, definition: &'static HistoryDefinition, files: FileHistorySource, ) -> Result<(), HistoryRegistrationError>

Register presentation for this component’s document, as Self::register_document_history, and for the files of the mounted filesystem it shows: every checked-file scope reads the file files names.

Errors

As Self::register_document_history.

pub fn new( context: HostContext, root: Box<dyn AppWidget>, registry: ActionRegistry, ) -> AppComponent

pub fn record(&self) -> &RecordCheckout

pub fn mount( &mut self, sink: impl Fn(WakeEvent) + Send + Sync + 'static, ) -> Result<(), LaunchError>

Errors

A component can be mounted once and a closed lifetime cannot be reopened.

pub fn mount_with_owner_queue( &mut self, queue: &OwnerWakeQueue, sink: impl Fn(WakeEvent) + Send + Sync + 'static, ) -> Result<(), LaunchError>

Mount with exact-owner queue intake while retaining the original host sink. Registration owns no application callback and its sink retains only weak metadata.

Errors

Refuses unprepared, already registered, stale or closed components.

pub fn capture_local_view(&self) -> Result<View, ThawError>

Errors

Rejects closed components and invalid widget geometry.

pub fn restore_local_view(&mut self, view: &View) -> Result<(), ThawError>

Local hooks cover scroll, mode and focused ephemeral state. App-specific fields absent from View are unsupported; they must not be smuggled in as document bytes.

Errors

Rejects malformed geometry or closed components before invoking widget hooks.

pub fn suspend(&mut self) -> ComponentCloseReport

pub fn close(&mut self) -> ComponentCloseReport

Save through the original store, retain failures, and permanently close this lifetime.

pub fn close_report(&self) -> Option<&ComponentCloseReport>

Trait Implementations

impl Drop for AppComponent

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.