Struct DeviceProxy 

pub struct DeviceProxy { /* private fields */ }

Implementations

impl DeviceProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.haptics/Device.

pub fn take_event_stream(&self) -> DeviceEventStream

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

Panics

Panics if the event stream was already taken.

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

Deprecated. Do not use. TODO(b/419629139): Remove once no longer used.

pub fn play_vibration( &self, duration: i64, ) -> QueryResponseFut<DevicePlayVibrationResult, DefaultFuchsiaResourceDialect>

Play a constant vibration for a period of time. Returns ZX_ERR_BAD_STATE if a vibration is currently playing.

Function does not return until the vibration has completed.

pub fn play_effect( &self, effect: Effect, strength: EffectStrength, ) -> QueryResponseFut<DevicePlayEffectResult, DefaultFuchsiaResourceDialect>

Play an effect. Returns ZX_ERR_BAD_STATE if a vibration is currently playing.

Function does not return until the vibration has completed.

pub fn play_composite_waveform( &self, composite_waveform: &[CompositeEffect], ) -> QueryResponseFut<DevicePlayCompositeWaveformResult, DefaultFuchsiaResourceDialect>

Play a composite waveform. Returns ZX_ERR_BAD_STATE if a vibration is currently playing.

Function does not return until the vibration has completed.

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

Stops the vibration that is currently playing. Does nothing if there isn’t a vibration currently playing.

Function does not return until the vibration has stopped and its corresponding FIDL request to play the vibration has completed.

pub fn set_amplitude( &self, amplitude: f32, ) -> QueryResponseFut<DeviceSetAmplitudeResult, DefaultFuchsiaResourceDialect>

Alters the gain on vibrations played in the future.

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

Returns the haptics-related properties of the haptics device.

Trait Implementations

impl Clone for DeviceProxy

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceProxy

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

Formats the value using the given formatter.

impl DeviceProxyInterface for DeviceProxy

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

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

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

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

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

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

type GetPropertiesResponseFut = QueryResponseFut<Result<(f32, f32, Vec<SupportedEffect>, Vec<SupportedCompositeEffectWaveform>, u64, i64), i32>>

fn start_vibration(&self) -> Self::StartVibrationResponseFut

fn play_vibration(&self, duration: i64) -> Self::PlayVibrationResponseFut

fn play_effect( &self, effect: Effect, strength: EffectStrength, ) -> Self::PlayEffectResponseFut

fn play_composite_waveform( &self, composite_waveform: &[CompositeEffect], ) -> Self::PlayCompositeWaveformResponseFut

fn stop_vibration(&self) -> Self::StopVibrationResponseFut

fn set_amplitude(&self, amplitude: f32) -> Self::SetAmplitudeResponseFut

fn get_properties(&self) -> Self::GetPropertiesResponseFut

impl Proxy for DeviceProxy

type Protocol = DeviceMarker

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<'_, NullableHandle>>

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