Skip to main content

InputOwnershipProxy

Struct InputOwnershipProxy 

Source
pub struct InputOwnershipProxy { /* private fields */ }

Implementations§

Source§

impl InputOwnershipProxy

Source

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.ui.input.internal/InputOwnership.

Source

pub fn take_event_stream(&self) -> InputOwnershipEventStream

Get a Stream of events from the remote end of the protocol.

§Panics

Panics if the event stream was already taken.

Source

pub fn get_event( &self, target: InputOwnershipTarget, ) -> QueryResponseFut<InputOwnershipGetEventResult, DefaultFuchsiaResourceDialect> ⓘ

Gets a duplicate handle to the shared kernel ownership_event whose orthogonal signals inform clients and the system pipeline when direct driver input access (fuchsia.input.report.Service) is granted or revoked:

  • Virtcon (target = virtcon: {}): owns input iff InputOwnershipSignal.DISPLAY_UNOWNED is asserted.
  • Starnix (target = view_ref): owns direct input iff both InputOwnershipSignal.DISPLAY_PLATFORM_OWNED and InputOwnershipSignal.INPUT_CLIENT_OWNED are asserted.
  • SceneManager (target = platform: {}): owns platform pipeline input iff both InputOwnershipSignal.DISPLAY_PLATFORM_OWNED and InputOwnershipSignal.INPUT_PLATFORM_OWNED are asserted (pauses whenever DISPLAY_UNOWNED or INPUT_CLIENT_OWNED is asserted).

Requesting direct input ownership:

Calling GetEvent with target = view_ref is also how a view requests direct input ownership; there is no separate request method. GetEvent supports pre-registering a valid ViewRef before the view is created or attached to the ViewTree. On success, the server registers the ViewRef as the system-wide direct input client, immediately evaluates it against the latest ViewTree snapshot if one exists, and continues evaluating it against the single-view + full-screen criteria on every subsequent ViewTree update. INPUT_CLIENT_OWNED is asserted only while the registered view meets those criteria; otherwise INPUT_PLATFORM_OWNED is asserted.

  • Registration is singleton and last-writer-wins: a successful call with a different ViewRef replaces any previously registered view. This mechanism is intended for a single trusted client replacing its own view rather than independent concurrent components: because every GetEvent call returns a handle to the same shared kernel ownership_event, replacing the registered ViewRef does not silence earlier callers’ handles when their view is unlinked or destroyed and the new view goes fullscreen.
  • If the ViewTree contains more than one view or overlay competing with the registered view, the criteria are not met and ownership falls back to the platform. Thus, when multiple views request direct input while coexisting in the ViewTree, none of them is granted direct input, regardless of which one registered last.
  • Registration is tied to the lifetime of the view, not to this channel or the returned event. Unlinking the view from the ViewTree (placing it in unconnected_views) reverts ownership to INPUT_PLATFORM_OWNED while retaining the registration, so re-linking fullscreen restores INPUT_CLIENT_OWNED. Destroying the view permanently drops the registration, at which point ownership reverts to the platform.
  • Calls with virtcon: {} or platform: {} only observe ownership and do not modify the registered direct client.

If target is set to an unsupported or unknown variant, the call returns InputOwnershipError.INVALID_TARGET.

Trait Implementations§

Source§

impl Clone for InputOwnershipProxy

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InputOwnershipProxy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl InputOwnershipProxyInterface for InputOwnershipProxy

Source§

impl Proxy for InputOwnershipProxy

Source§

type Protocol = InputOwnershipMarker

The protocol which this Proxy controls.
Source§

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.
Source§

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel. Read more
Source§

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel. Read more
Source§

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end. Read more
Source§

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.
Source§

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, NullableHandle>> ⓘ

Returns a future that completes when the proxy receives the PEER_CLOSED signal.

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
§

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

§

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

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

Source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
Source§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

Source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromClient for T
where T: Proxy,

Source§

type Protocol = <T as Proxy>::Protocol

The protocol.
Source§

fn from_client(value: ClientEnd<<T as FromClient>::Protocol>) -> T

Converts from a client.
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.

§

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
Source§

impl<T> ProxyHasDomain for T
where T: Proxy,

Source§

fn domain(&self) -> ZirconClient

Get a “client” for this proxy. This is just an object which has methods for a few common handle creation operations.
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.