Skip to main content

NativeSession

Struct NativeSession 

Source
pub struct NativeSession { /* private fields */ }
Expand description

Owns an embedded composition and its worker thread.

Platform CranposeView adapters drive this session automatically. An application creates one with NativeSession::new and supplies only its content and events.

Implementations§

Source§

impl NativeSession

Source

pub fn new( factory: impl FnOnce() -> NativeContent + Send + 'static, ) -> Arc<Self> ⓘ

Constructs content on the owning worker. Captures crossing into this factory must be Send; the composition and its state stay on that worker afterwards.

Source§

impl NativeSession

Source

pub fn set_listener( &self, listener: Box<dyn FrameListener>, ) -> Result<(), NativeError>

Attaches the platform frame callback and requests an initial frame.

Source

pub async fn frame( &self, width: u32, height: u32, density: f32, ) -> Result<NativeFrame, NativeError>

Produces the next presentation update. Platform adapters serialize these calls.

Source

pub fn send_event(&self, name: String, value: String) -> Result<(), NativeError>

Delivers application input without exposing rendering internals.

Source

pub fn touch( &self, phase: TouchPhase, x: f32, y: f32, ) -> Result<(), NativeError>

Routes a pointer event in logical points.

Source

pub fn native_event(&self, id: u64, event: String) -> Result<(), NativeError>

Routes a factory event from a mounted native child; stale IDs are ignored.

Source

pub fn set_visible(&self, visible: bool) -> Result<(), NativeError>

Suspends hidden or detached content and resumes it when visible.

Source

pub fn shutdown(&self)

Releases the worker and its composition. Safe to call repeatedly.

Trait Implementations§

Source§

impl Drop for NativeSession

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more
Source§

impl<UT> LiftRef<UT> for NativeSession

Source§

impl<UT> LowerError<UT> for NativeSession

Source§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
Source§

impl<UT> LowerReturn<UT> for NativeSession

Source§

type ReturnType = <Arc<NativeSession> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type. Read more
Source§

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call Read more
Source§

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts Read more
Source§

impl<UT> TypeId<UT> for NativeSession

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

unsafe fn consume_handle(handle: Handle) -> Arc<T> ⓘ

Consume a handle, getting back the initial Arc<> Read more
Source§

unsafe fn get_arc(handle: Handle) -> Arc<Self> ⓘ

Get a clone of the Arc<> using a “borrowed” handle. 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,