Struct ComponentDataRegisterSynchronousProxy

pub struct ComponentDataRegisterSynchronousProxy { /* private fields */ }

Implementations

impl ComponentDataRegisterSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ComponentDataRegisterEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn upsert( &self, data: &ComponentData, ___deadline: MonotonicInstant, ) -> Result<(), Error>

Upserts, i.e. updates or inserts, extra component data to be included in feedback reports.

The namespace and each annotation key are used to decide whether to update or insert an annotation. If an annotation is already present for a given key within the same namespace, update the value, otherwise insert the annotation with that key under that namespace.

For instance, assuming these are the data already held by the server (from previous calls to Upsert()):

{
  "bar": { # namespace
    "channel": "stable",
  },
  "foo": { # namespace
    "version": "0.2",
  }
}

then:

Upsert({
  "namespace": "bar",
  "annotations": [
    "version": "1.2.3.45",
    "channel": "beta",
  ]
})

would result in the server now holding:

{
  "bar": { # namespace
    "channel": "beta", # updated
    "version": "1.2.3.45" # inserted
  },
  "foo": { # namespace
    "version": "0.2", # untouched
  }
}

Note that the server will only hold at most MAX_NUM_ANNOTATIONS_PER_NAMESPACE distinct annotation keys per namespace, picking up the latest values.

Trait Implementations

impl Debug for ComponentDataRegisterSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for ComponentDataRegisterSynchronousProxy

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<ComponentDataRegisterSynchronousProxy> for Handle

fn from(value: ComponentDataRegisterSynchronousProxy) -> Self

Converts to this type from the input type.

impl SynchronousProxy for ComponentDataRegisterSynchronousProxy

type Proxy = ComponentDataRegisterProxy

The async proxy for the same protocol.

type Protocol = ComponentDataRegisterMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.