pub struct RemoteServiceProxy { /* private fields */ }

Implementations§

source§

impl RemoteServiceProxy

source

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.bluetooth.gatt/RemoteService.

source

pub fn take_event_stream(&self) -> RemoteServiceEventStream

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

§Panics

Panics if the event stream was already taken.

source

pub fn discover_characteristics( &self, ) -> QueryResponseFut<(Status, Vec<Characteristic>)>

Returns the characteristics and characteristic descriptors that belong to this service.

source

pub fn read_characteristic( &self, id: u64, ) -> QueryResponseFut<(Status, Vec<u8>)>

Reads the value of the characteristic with id and returns it in the reply. If status indicates an error value will be empty.

If the characteristic has a long value (i.e. larger than the current MTU) this method will return only the first (MTU - 1) bytes of the value. Use ReadLongCharacteristic() to read larger values or starting at a non-zero offset.

source

pub fn read_long_characteristic( &self, id: u64, offset: u16, max_bytes: u16, ) -> QueryResponseFut<(Status, Vec<u8>)>

Reads the complete value of a characteristic with the given id. This procedure should be used if the characteristic is known to have a value that can not be read in a single request.

Returns up to max_bytes octets of the characteristic value starting at the given offset.

This may return an error if: a. max_bytes is 0; b. The offset is invalid; c. The characteristic does not have a long value; d. The server does not support the long read procedure.

source

pub fn write_characteristic( &self, id: u64, value: &[u8], ) -> QueryResponseFut<Status>

Writes value to the characteristic with id. This operation may return an error if: a. The size of value exceeds the current MTU. b. The characteristic referred to by id does not have the ‘write’ property.

source

pub fn write_long_characteristic( &self, id: u64, offset: u16, value: &[u8], write_options: &WriteOptions, ) -> QueryResponseFut<Status>

Writes value to the characteristic with id, beginning at offset using the provided write_options.

This procedure should be used if the value to be written is too long to fit in a single request or needs to be written at an offset. This may return an error if: a. The offset is invalid; b. The server does not support the long write procedure.

Long Writes require multiple messages to the remote service and take longer to execute than Short Writes. It is not recommended to send a short write while a long write is in process to the same id and data range. The order of the responses from this function signify the order in which the remote service received them, not necessarily the order in which it is called.

source

pub fn write_characteristic_without_response( &self, id: u64, value: &[u8], ) -> Result<(), Error>

Writes value to the characteristic with id without soliciting an acknowledgement from the peer. This method has no response and its delivery cannot be confirmed.

source

pub fn read_descriptor(&self, id: u64) -> QueryResponseFut<(Status, Vec<u8>)>

Reads the value of the characteristic descriptor with id and returns it in the reply. If status indicates an error, value can be ignored.

If the descriptor has a long value (i.e. larger than the current MTU) this method will return only the first (MTU - 1) bytes of the value. Use ReadLongDescriptor() to read larger values or starting at a non-zero offset.

source

pub fn read_long_descriptor( &self, id: u64, offset: u16, max_bytes: u16, ) -> QueryResponseFut<(Status, Vec<u8>)>

Reads the complete value of a characteristic descriptor with the given id. This procedure should be used if the descriptor is known to have a value that can not be read in a single request.

Returns up to max_bytes octets of the characteristic value starting at the given offset.

This may return an error if: a. max_bytes is 0; b. The offset is invalid; c. The server does not support the long read procedure.

source

pub fn write_descriptor( &self, id: u64, value: &[u8], ) -> QueryResponseFut<Status>

Writes value to the characteristic descriptor with id. This operation may return an error if: a. The size of value exceeds the current MTU. b. id refers to an internally reserved descriptor type (e.g. the Client Characteristic Configuration descriptor).

source

pub fn write_long_descriptor( &self, id: u64, offset: u16, value: &[u8], ) -> QueryResponseFut<Status>

Writes value to the characteristic descriptor with id, beginning at offset. This procedure should be used if the value to be written is too long to fit in a single request or needs to be written at an offset. This may return an error if: a. The offset is invalid; b. The server does not support the long write procedure. c. id refers to an internally reserved descriptor type (e.g. the Client Characteristic Configuration descriptor).

Long Writes require multiple messages to the remote service and take longer to execute than Short Writes. It is not recommended to send a short write while a long write is in process to the same id and data range. The order of the responses from this function signify the order in which the remote service received them, not necessarily the order in which it is called.

source

pub fn read_by_type( &self, uuid: &Uuid, ) -> QueryResponseFut<RemoteServiceReadByTypeResult>

Reads characteristics and descriptors with the given uuid. If no values are read, results will be empty. If reading a value results in a permission error, the handle and error will be included in results.

NOTE: Values in results will be truncated to MAX_READ_BY_TYPE_VALUE_LENGTH bytes. ReadCharacteristic, ReadLongCharacteristic(), ReadDescriptor, or ReadLongDescriptor() should be used to read the complete values.

This method is useful for reading values before discovery has completed, thereby reducing latency.

source

pub fn notify_characteristic( &self, id: u64, enable: bool, ) -> QueryResponseFut<Status>

Subscribe or unsubscribe to notifications/indications from the characteristic with the given id. Notifications or indications will be enabled if enable is true or disabled if enable is false and they have been enabled for this client.

Either notifications or indications will be enabled depending on characteristic properties. Indications will be preferred if they are supported.

This operation fails if the characteristic does not have the “notify” or “indicate” property.

A write request will be issued to configure the characteristic for notifications/indications if it contains a Client Characteristic Configuration descriptor. This method fails if an error occurs while writing to the descriptor.

On success, the OnCharacteristicValueUpdated event will be sent whenever the peer sends a notification or indication. The local host will automically confirm indications.

Trait Implementations§

source§

impl Clone for RemoteServiceProxy

source§

fn clone(&self) -> RemoteServiceProxy

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RemoteServiceProxy

source§

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

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

impl Proxy for RemoteServiceProxy

§

type Protocol = RemoteServiceMarker

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
§

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

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

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.
source§

impl RemoteServiceProxyInterface for RemoteServiceProxy

§

type DiscoverCharacteristicsResponseFut = QueryResponseFut<(Status, Vec<Characteristic>)>

source§

fn discover_characteristics(&self) -> Self::DiscoverCharacteristicsResponseFut

§

type ReadCharacteristicResponseFut = QueryResponseFut<(Status, Vec<u8>)>

source§

fn read_characteristic(&self, id: u64) -> Self::ReadCharacteristicResponseFut

§

type ReadLongCharacteristicResponseFut = QueryResponseFut<(Status, Vec<u8>)>

source§

fn read_long_characteristic( &self, id: u64, offset: u16, max_bytes: u16, ) -> Self::ReadLongCharacteristicResponseFut

§

type WriteCharacteristicResponseFut = QueryResponseFut<Status>

source§

fn write_characteristic( &self, id: u64, value: &[u8], ) -> Self::WriteCharacteristicResponseFut

§

type WriteLongCharacteristicResponseFut = QueryResponseFut<Status>

source§

fn write_long_characteristic( &self, id: u64, offset: u16, value: &[u8], write_options: &WriteOptions, ) -> Self::WriteLongCharacteristicResponseFut

source§

fn write_characteristic_without_response( &self, id: u64, value: &[u8], ) -> Result<(), Error>

§

type ReadDescriptorResponseFut = QueryResponseFut<(Status, Vec<u8>)>

source§

fn read_descriptor(&self, id: u64) -> Self::ReadDescriptorResponseFut

§

type ReadLongDescriptorResponseFut = QueryResponseFut<(Status, Vec<u8>)>

source§

fn read_long_descriptor( &self, id: u64, offset: u16, max_bytes: u16, ) -> Self::ReadLongDescriptorResponseFut

§

type WriteDescriptorResponseFut = QueryResponseFut<Status>

source§

fn write_descriptor( &self, id: u64, value: &[u8], ) -> Self::WriteDescriptorResponseFut

§

type WriteLongDescriptorResponseFut = QueryResponseFut<Status>

source§

fn write_long_descriptor( &self, id: u64, offset: u16, value: &[u8], ) -> Self::WriteLongDescriptorResponseFut

§

type ReadByTypeResponseFut = QueryResponseFut<Result<Vec<ReadByTypeResult>, Error>>

source§

fn read_by_type(&self, uuid: &Uuid) -> Self::ReadByTypeResponseFut

§

type NotifyCharacteristicResponseFut = QueryResponseFut<Status>

source§

fn notify_characteristic( &self, id: u64, enable: bool, ) -> Self::NotifyCharacteristicResponseFut

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<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

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

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

§

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
§

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

§

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. 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.

§

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> ToOwned for T
where T: Clone,

§

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>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more