Struct GuestProxy

pub struct GuestProxy { /* private fields */ }

Implementations

impl GuestProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.virtualization/Guest.

pub fn take_event_stream(&self) -> GuestEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get_console( &self, ) -> QueryResponseFut<GuestGetConsoleResult, DefaultFuchsiaResourceDialect>

Get a guest console.

The details regarding what output is produced and what input is accepted are determined by each guest, but will typically be a read/write socket with a shell.

Returns error DEVICE_NOT_PRESENT if the guest was started without a console device.

pub fn get_serial( &self, ) -> QueryResponseFut<Socket, DefaultFuchsiaResourceDialect>

Get the socket for low-level guest debug logs.

The details regarding what output is produced and what input is accepted are determined by each guest, but will typically be a read-only socket with the guest kernel’s serial logs.

pub fn get_host_vsock_endpoint( &self, endpoint: ServerEnd<HostVsockEndpointMarker>, ) -> QueryResponseFut<GuestGetHostVsockEndpointResult, DefaultFuchsiaResourceDialect>

Get the vsock endpoint for the guest.

This endpoint can be used to register listeners for guest initiated connections, and to initiate connections from a client. If listeners need to be registered before the guest starts so that they are immediately available, set them via the guest config instead of using this endpoint.

Returns error DEVICE_NOT_PRESENT if the guest was started without a vsock device.

pub fn get_balloon_controller( &self, controller: ServerEnd<BalloonControllerMarker>, ) -> QueryResponseFut<GuestGetBalloonControllerResult, DefaultFuchsiaResourceDialect>

Get the balloon controller endpoint for the guest.

Returns error DEVICE_NOT_PRESENT if the guest was started without a balloon device.

pub fn get_mem_controller( &self, controller: ServerEnd<MemControllerMarker>, ) -> QueryResponseFut<GuestGetMemControllerResult, DefaultFuchsiaResourceDialect>

Get the mem controller endpoint for the guest.

Returns error DEVICE_NOT_PRESENT if the guest was started without a mem device.

Trait Implementations

impl Clone for GuestProxy

fn clone(&self) -> GuestProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GuestProxy

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

Formats the value using the given formatter.

impl GuestProxyInterface for GuestProxy

type GetConsoleResponseFut = QueryResponseFut<Result<Socket, GuestError>>

type GetSerialResponseFut = QueryResponseFut<Socket>

type GetHostVsockEndpointResponseFut = QueryResponseFut<Result<(), GuestError>>

type GetBalloonControllerResponseFut = QueryResponseFut<Result<(), GuestError>>

type GetMemControllerResponseFut = QueryResponseFut<Result<(), GuestError>>

fn get_console(&self) -> Self::GetConsoleResponseFut

fn get_serial(&self) -> Self::GetSerialResponseFut

fn get_host_vsock_endpoint( &self, endpoint: ServerEnd<HostVsockEndpointMarker>, ) -> Self::GetHostVsockEndpointResponseFut

fn get_balloon_controller( &self, controller: ServerEnd<BalloonControllerMarker>, ) -> Self::GetBalloonControllerResponseFut

fn get_mem_controller( &self, controller: ServerEnd<MemControllerMarker>, ) -> Self::GetMemControllerResponseFut

impl Proxy for GuestProxy

type Protocol = GuestMarker

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.