Struct AnnotationControllerProxy

pub struct AnnotationControllerProxy { /* private fields */ }

Implementations

impl AnnotationControllerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.element/AnnotationController.

pub fn take_event_stream(&self) -> AnnotationControllerEventStream

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

Panics

Panics if the event stream was already taken.

pub fn update_annotations( &self, annotations_to_set: Vec<Annotation>, annotations_to_delete: &[AnnotationKey], ) -> QueryResponseFut<AnnotationControllerUpdateAnnotationsResult, DefaultFuchsiaResourceDialect>

Adds, updates, and removes annotations.

The server is expected to adhere to the following conventions:

• If a key in annotations_to_set is new, a new annotation is added
• If a key in annotations_to_set already exists, the annotation value is updated
• If a key in annotations_to_delete does not exist, it is ignored

The same key cannot appear twice in a call to UpdateAnnotations(). In other words, to set two Annotations with matching keys is illegal, as is an attempt to set an Annotation and also delete it.

If the operation results in an error, the annotations remain unchanged, and will not be partially updated.

• error UpdateAnnotationsError.INVALID_ARGS if the same key exists in both annotations_to_set and annotations_to_delete.
• error UpdateAnnotationsError.INVALID_ARGS if a key in annotations_to_set or annotations_to_delete has an empty namespace.
• error UpdateAnnotationsError.INVALID_ARGS if an AnnotationValue.buffer in annotations_to_set could not be read.
• error UpdateAnnotationsError.TOO_MANY_ANNOTATIONS if the operation results in more than MAX_ANNOTATIONS_PER_ELEMENT annotations existing.

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

Returns the current Annotations for the element.

• error GetAnnotationsError if the annotations could not be returned.

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

Returns the full set of Annotations when one or more of them have changed, or when this method is called by the client for the first time.

This operation does not block other requests from the client, but only one WatchAnnotations request at a time can be made on a connection. If the client makes a second WatchAnnotations request before waiting for the previous request to complete, the connection will be closed.

• error WatchAnnotationsError if the annotations could not be returned.

Trait Implementations

impl AnnotationControllerProxyInterface for AnnotationControllerProxy

type UpdateAnnotationsResponseFut = QueryResponseFut<Result<(), UpdateAnnotationsError>>

type GetAnnotationsResponseFut = QueryResponseFut<Result<Vec<Annotation>, GetAnnotationsError>>

type WatchAnnotationsResponseFut = QueryResponseFut<Result<Vec<Annotation>, WatchAnnotationsError>>

fn update_annotations( &self, annotations_to_set: Vec<Annotation>, annotations_to_delete: &[AnnotationKey], ) -> Self::UpdateAnnotationsResponseFut

fn get_annotations(&self) -> Self::GetAnnotationsResponseFut

fn watch_annotations(&self) -> Self::WatchAnnotationsResponseFut

impl Clone for AnnotationControllerProxy

fn clone(&self) -> AnnotationControllerProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotationControllerProxy

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

Formats the value using the given formatter.

impl Proxy for AnnotationControllerProxy

type Protocol = AnnotationControllerMarker

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.