Struct HidbusProxy

pub struct HidbusProxy { /* private fields */ }

Implementations

impl HidbusProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.hidbus/Hidbus.

pub fn take_event_stream(&self) -> HidbusEventStream

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

Panics

Panics if the event stream was already taken.

pub fn query( &self, ) -> QueryResponseFut<HidbusQueryResult, DefaultFuchsiaResourceDialect>

Obtain information about the hidbus device and supported features. Safe to call at any time.

pub fn start( &self, ) -> QueryResponseFut<HidbusStartResult, DefaultFuchsiaResourceDialect>

Start the hidbus device. The device may begin queueing hid reports via OnReportReceived before this function returns. The hidbus device will keep track of the number of times Start has been called and will only be stopped when Stop has been called for each Start that has been called. Theoretically, Start should not be called again by the same client unless it has called Stop.

pub fn stop(&self) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Stop the hidbus device.

pub fn get_descriptor( &self, desc_type: HidDescriptorType, ) -> QueryResponseFut<HidbusGetDescriptorResult, DefaultFuchsiaResourceDialect>

Methods matching HID spec 1.11 Chapter 7 Requests 7.1.1 Get_Descriptor

pub fn set_descriptor( &self, desc_type: HidDescriptorType, data: &[u8], ) -> QueryResponseFut<HidbusSetDescriptorResult, DefaultFuchsiaResourceDialect>

7.1.2 Set_Descriptor (optional)

pub fn get_report( &self, rpt_type: ReportType, rpt_id: u8, len: u64, ) -> QueryResponseFut<HidbusGetReportResult, DefaultFuchsiaResourceDialect>

7.2.1 Get_Report

pub fn set_report( &self, rpt_type: ReportType, rpt_id: u8, data: &[u8], ) -> QueryResponseFut<HidbusSetReportResult, DefaultFuchsiaResourceDialect>

7.2.2 Set_Report

pub fn get_idle( &self, rpt_id: u8, ) -> QueryResponseFut<HidbusGetIdleResult, DefaultFuchsiaResourceDialect>

7.2.3 Get_Idle

pub fn set_idle( &self, rpt_id: u8, duration: i64, ) -> QueryResponseFut<HidbusSetIdleResult, DefaultFuchsiaResourceDialect>

7.2.4 Set_Idle

pub fn get_protocol( &self, ) -> QueryResponseFut<HidbusGetProtocolResult, DefaultFuchsiaResourceDialect>

7.2.5 Get_Protocol

pub fn set_protocol( &self, protocol: HidProtocol, ) -> QueryResponseFut<HidbusSetProtocolResult, DefaultFuchsiaResourceDialect>

7.2.6 Set_Protocol

Trait Implementations

impl Clone for HidbusProxy

fn clone(&self) -> HidbusProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HidbusProxy

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

Formats the value using the given formatter.

impl HidbusProxyInterface for HidbusProxy

type QueryResponseFut = QueryResponseFut<Result<HidInfo, i32>>

type StartResponseFut = QueryResponseFut<Result<(), i32>>

type StopResponseFut = QueryResponseFut<()>

type GetDescriptorResponseFut = QueryResponseFut<Result<Vec<u8>, i32>>

type SetDescriptorResponseFut = QueryResponseFut<Result<(), i32>>

type GetReportResponseFut = QueryResponseFut<Result<Vec<u8>, i32>>

type SetReportResponseFut = QueryResponseFut<Result<(), i32>>

type GetIdleResponseFut = QueryResponseFut<Result<i64, i32>>

type SetIdleResponseFut = QueryResponseFut<Result<(), i32>>

type GetProtocolResponseFut = QueryResponseFut<Result<HidProtocol, i32>>

type SetProtocolResponseFut = QueryResponseFut<Result<(), i32>>

fn query(&self) -> Self::QueryResponseFut

fn start(&self) -> Self::StartResponseFut

fn stop(&self) -> Self::StopResponseFut

fn get_descriptor( &self, desc_type: HidDescriptorType, ) -> Self::GetDescriptorResponseFut

fn set_descriptor( &self, desc_type: HidDescriptorType, data: &[u8], ) -> Self::SetDescriptorResponseFut

fn get_report( &self, rpt_type: ReportType, rpt_id: u8, len: u64, ) -> Self::GetReportResponseFut

fn set_report( &self, rpt_type: ReportType, rpt_id: u8, data: &[u8], ) -> Self::SetReportResponseFut

fn get_idle(&self, rpt_id: u8) -> Self::GetIdleResponseFut

fn set_idle(&self, rpt_id: u8, duration: i64) -> Self::SetIdleResponseFut

fn get_protocol(&self) -> Self::GetProtocolResponseFut

fn set_protocol(&self, protocol: HidProtocol) -> Self::SetProtocolResponseFut

impl Proxy for HidbusProxy

type Protocol = HidbusMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

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

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

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

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

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

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