pub struct PackageCacheProxy { /* private fields */ }

Implementations§

source§

impl PackageCacheProxy

source

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.pkg/PackageCache.

source

pub fn take_event_stream(&self) -> PackageCacheEventStream

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

§Panics

Panics if the event stream was already taken.

source

pub fn get( &self, meta_far_blob: &BlobInfo, gc_protection: GcProtection, needed_blobs: ServerEnd<NeededBlobsMarker>, dir: Option<ServerEnd<DirectoryMarker>> ) -> QueryResponseFut<PackageCacheGetResult>

Gets the package directory if it is present on the local system. If it is not, the missing_blobs iterator will provide all the blobs in the package that are missing from the system, and the ability to write those blobs to blobfs. If all the missing blobs are downloaded and written to by the client, the dir directory will be resolved. This method will return successfully when the package has been fully resolved, or return an error if the client closes needed_blobs or dir handle before the package has been resolved.

This method does not guarantee the missing blobs have been persisted. In order to guarantee missing blobs are persisted, clients should call [‘Sync’].

Clients must not make concurrent Get() calls for the same meta_far_blob, even across different PackageCache connections, unless the meta_far_blob is in base or already active in the dynamic index. Violating this may result in Get() errors.

  • request meta_far_blob the blob info for the package’s meta.far.
  • request needed_blobs an iterator over all the blobs in the package that are not present on the system.
  • request dir an optional request for a directory that will be resolved when the package has been successfully cached.
  • error a zx_status value indicating failure. One of the following:
    • ZX_ERR_UNAVAILABLE if the client closed needed_blobs handles before all the missing blobs were downloaded to the system.
source

pub fn get_subpackage( &self, superpackage: &BlobId, subpackage: &PackageUrl, dir: ServerEnd<DirectoryMarker> ) -> QueryResponseFut<PackageCacheGetSubpackageResult>

Gets the package directory for a subpackage. The connection to the superpackage’s package directory must still be open when this is called. The returned package will be protected by open package tracking.

  • request superpackage the hash of the superpackage’s meta.far.
  • request subpackage the relative package URL of the subpackage.
  • request dir the channel on which the package directory will be served.
  • error a GetSubpackageError value indicating failure.
source

pub fn base_package_index( &self, iterator: ServerEnd<PackageIndexIteratorMarker> ) -> Result<(), Error>

Retrieves a chunk iterator to the base package index.

  • request iterator a request for the PackageIndexIterator that will return sets of PackageIndexEntry objects until all packages in the base index have been iterated.
source

pub fn cache_package_index( &self, iterator: ServerEnd<PackageIndexIteratorMarker> ) -> Result<(), Error>

Retrieves a chunk iterator to the cache package index.

  • request iterator a request for the PackageIndexIterator that will return sets of PackageIndexEntry objects until all packages in the cache index have been iterated.
source

pub fn sync(&self) -> QueryResponseFut<PackageCacheSyncResult>

Synchronizes updates to the cached packages to the underlying persistent storage.

  • error a zx_status value indicating failure. One of the following:
    • ZX_ERR_INTERNAL if the sync fails.

Trait Implementations§

source§

impl Clone for PackageCacheProxy

source§

fn clone(&self) -> PackageCacheProxy

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 PackageCacheProxy

source§

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

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

impl PackageCacheProxyInterface for PackageCacheProxy

§

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

source§

fn get( &self, meta_far_blob: &BlobInfo, gc_protection: GcProtection, needed_blobs: ServerEnd<NeededBlobsMarker>, dir: Option<ServerEnd<DirectoryMarker>> ) -> Self::GetResponseFut

§

type GetSubpackageResponseFut = QueryResponseFut<Result<(), GetSubpackageError>>

source§

fn get_subpackage( &self, superpackage: &BlobId, subpackage: &PackageUrl, dir: ServerEnd<DirectoryMarker> ) -> Self::GetSubpackageResponseFut

source§

fn base_package_index( &self, iterator: ServerEnd<PackageIndexIteratorMarker> ) -> Result<(), Error>

source§

fn cache_package_index( &self, iterator: ServerEnd<PackageIndexIteratorMarker> ) -> Result<(), Error>

§

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

source§

fn sync(&self) -> Self::SyncResponseFut

source§

impl Proxy for PackageCacheProxy

§

type Protocol = PackageCacheMarker

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

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

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
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _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> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _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