Struct RealmQueryProxy

pub struct RealmQueryProxy { /* private fields */ }

Implementations

impl RealmQueryProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.sys2/RealmQuery.

pub fn take_event_stream(&self) -> RealmQueryEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get_instance( &self, moniker: &str, ) -> QueryResponseFut<RealmQueryGetInstanceResult, DefaultFuchsiaResourceDialect>

Gets an instance identified by its moniker.

pub fn get_resolved_declaration( &self, moniker: &str, ) -> QueryResponseFut<RealmQueryGetResolvedDeclarationResult, DefaultFuchsiaResourceDialect>

Gets the manifest of an instance identified by its moniker.

The manifest is encoded in its standalone persistable format per RFC-0120 and is sent across using an iterator. Some manifests are too large to send over a Zircon channel and we can’t use a VMO because we need an approach that is compatible with overnet.

pub fn get_manifest( &self, moniker: &str, ) -> QueryResponseFut<RealmQueryGetManifestResult, DefaultFuchsiaResourceDialect>

Prefer GetResolvedDeclaration if available for your target API level.

pub fn resolve_declaration( &self, parent: &str, child_location: &ChildLocation, url: &str, ) -> QueryResponseFut<RealmQueryResolveDeclarationResult, DefaultFuchsiaResourceDialect>

Gets the manifest of a component URL as if it were a child of the specified parent without actually creating or starting that component.

The manifest is encoded in its standalone persistable format per RFC-0120 and is sent across using an iterator. Some manifests are too large to send over a Zircon channel and we can’t use a VMO because we need an approach that is compatible with overnet.

pub fn get_structured_config( &self, moniker: &str, ) -> QueryResponseFut<RealmQueryGetStructuredConfigResult, DefaultFuchsiaResourceDialect>

Gets the structured config of an instance identified by its moniker.

pub fn get_all_instances( &self, ) -> QueryResponseFut<RealmQueryGetAllInstancesResult, DefaultFuchsiaResourceDialect>

Returns an iterator over all component instances in this realm and instances within resolved children, recursively. Unresolved child components will be included in this list, but children of unresolved children will not be.

pub fn construct_namespace( &self, moniker: &str, ) -> QueryResponseFut<RealmQueryConstructNamespaceResult, DefaultFuchsiaResourceDialect>

Constructs the namespace of an instance as determined by its use declarations. This is usually identical to what would be given to the component’s runner on component start time, unless extended by fuchsia.component/StartChildArgs.namespace_entries.

pub fn open_directory( &self, moniker: &str, dir_type: OpenDirType, object: ServerEnd<DirectoryMarker>, ) -> QueryResponseFut<RealmQueryOpenDirectoryResult, DefaultFuchsiaResourceDialect>

Opens the specified directory in an instance.

pub fn connect_to_storage_admin( &self, moniker: &str, storage_name: &str, server_end: ServerEnd<StorageAdminMarker>, ) -> QueryResponseFut<RealmQueryConnectToStorageAdminResult, DefaultFuchsiaResourceDialect>

Connects to the StorageAdmin protocol of a storage declared by an instance.

pub fn deprecated_open( &self, moniker: &str, dir_type: OpenDirType, flags: OpenFlags, mode: ModeType, path: &str, object: ServerEnd<NodeMarker>, ) -> QueryResponseFut<RealmQueryDeprecatedOpenResult, DefaultFuchsiaResourceDialect>

[DEPRECATED - Use OpenDirectory instead.]

Makes an fuchsia.io.Directory/Open call on a directory in an instance.

Trait Implementations

impl Clone for RealmQueryProxy

fn clone(&self) -> RealmQueryProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RealmQueryProxy

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

Formats the value using the given formatter.

impl Proxy for RealmQueryProxy

type Protocol = RealmQueryMarker

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.

impl RealmQueryProxyInterface for RealmQueryProxy

type GetInstanceResponseFut = QueryResponseFut<Result<Instance, GetInstanceError>>

type GetResolvedDeclarationResponseFut = QueryResponseFut<Result<ClientEnd<ManifestBytesIteratorMarker>, GetDeclarationError>>

type GetManifestResponseFut = QueryResponseFut<Result<ClientEnd<ManifestBytesIteratorMarker>, GetDeclarationError>>

type ResolveDeclarationResponseFut = QueryResponseFut<Result<ClientEnd<ManifestBytesIteratorMarker>, GetDeclarationError>>

type GetStructuredConfigResponseFut = QueryResponseFut<Result<ResolvedConfig, GetStructuredConfigError>>

type GetAllInstancesResponseFut = QueryResponseFut<Result<ClientEnd<InstanceIteratorMarker>, GetAllInstancesError>>

type ConstructNamespaceResponseFut = QueryResponseFut<Result<Vec<ComponentNamespaceEntry>, ConstructNamespaceError>>

type OpenDirectoryResponseFut = QueryResponseFut<Result<(), OpenError>>

type ConnectToStorageAdminResponseFut = QueryResponseFut<Result<(), ConnectToStorageAdminError>>

type DeprecatedOpenResponseFut = QueryResponseFut<Result<(), OpenError>>

fn get_instance(&self, moniker: &str) -> Self::GetInstanceResponseFut

fn get_resolved_declaration( &self, moniker: &str, ) -> Self::GetResolvedDeclarationResponseFut

fn get_manifest(&self, moniker: &str) -> Self::GetManifestResponseFut

fn resolve_declaration( &self, parent: &str, child_location: &ChildLocation, url: &str, ) -> Self::ResolveDeclarationResponseFut

fn get_structured_config( &self, moniker: &str, ) -> Self::GetStructuredConfigResponseFut

fn get_all_instances(&self) -> Self::GetAllInstancesResponseFut

fn construct_namespace( &self, moniker: &str, ) -> Self::ConstructNamespaceResponseFut

fn open_directory( &self, moniker: &str, dir_type: OpenDirType, object: ServerEnd<DirectoryMarker>, ) -> Self::OpenDirectoryResponseFut

fn connect_to_storage_admin( &self, moniker: &str, storage_name: &str, server_end: ServerEnd<StorageAdminMarker>, ) -> Self::ConnectToStorageAdminResponseFut

fn deprecated_open( &self, moniker: &str, dir_type: OpenDirType, flags: OpenFlags, mode: ModeType, path: &str, object: ServerEnd<NodeMarker>, ) -> Self::DeprecatedOpenResponseFut