Struct NeededBlobsSynchronousProxy

pub struct NeededBlobsSynchronousProxy { /* private fields */ }

Implementations

impl NeededBlobsSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<NeededBlobsEvent, 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 open_meta_blob( &self, ___deadline: MonotonicInstant, ) -> Result<NeededBlobsOpenMetaBlobResult, Error>

Opens the package’s metadata blob for writing. GetMissingBlobs() should not be called until writing the meta blob or this request responds with false.

If the package was already cached, server will close the channel with a ZX_OK epitaph.

• response writer is used to write the blob. If writer is absent, the blob is already cached and so does not need to be written.

• error an OpenBlobError indicating failure. Clients may retry this request, though the server end may abort this cache operation on errors it considers to be fatal.

pub fn get_missing_blobs( &self, iterator: ServerEnd<BlobInfoIteratorMarker>, ) -> Result<(), Error>

Returns an iterator of blobs that are not present on the system that must be written using the OpenBlob request before the package will be fully cached.

Client should call OpenMetaBlob, and write it if needed, before calling GetMissingBlobs.

A client should make this request no more than once per NeededBlobs connection. Once all blobs yielded by this iterator are written, the package open request will complete.

New items may be added to the obtained BlobInfoIterator as the client calls OpenBlob, so, to guaranatee termination of the iterator, clients should call OpenBlob concurrently with reading the iterator.

• request iterator a request for an iterator of BlobInfo of blobs that the client should try to write.

pub fn open_blob( &self, blob_id: &BlobId, ___deadline: MonotonicInstant, ) -> Result<NeededBlobsOpenBlobResult, Error>

Opens a blob for writing.

• request blob_id the blob id describing this blob.

• response writer is used to write the blob. If writer is absent, the blob is already cached and so does not need to be written.

• error an OpenBlobError indicating failure. Clients may retry this request, though the server end may abort this cache operation on errors it considers to be fatal.

pub fn blob_written( &self, blob_id: &BlobId, ___deadline: MonotonicInstant, ) -> Result<NeededBlobsBlobWrittenResult, Error>

Indicates that a blob opened by Open[Meta]Blob has been successfully written.

A client should call this once the blob has been fully written using the writer returned by Open[Meta]Blob.

• request blob_id the blob id describing this blob.

• error a BlobWrittenError indicating failure. Clients may retry the Open[Meta]Blob request that prompted this call, though the server end may abort this cache operation on errors it considers to be fatal.

pub fn abort(&self, ___deadline: MonotonicInstant) -> Result<(), Error>

Aborts this caching operation for the package.

Any open blobs and any missing blobs iterator will be closed. Any dir provided to the associated [PackageCache.Get] request will also be closed. Once this request is acknowledged, this channel will be closed.

Note, dropping this NeededBlobs channel without writing all needed blobs will also abort the package cache operation. However, this API provides the ability to wait for the operation to be torn down.

Trait Implementations

impl Debug for NeededBlobsSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for NeededBlobsSynchronousProxy

type Proxy = NeededBlobsProxy

The async proxy for the same protocol.

type Protocol = NeededBlobsMarker

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.