Enum GuestRequest

pub enum GuestRequest {
    GetConsole {
        responder: GuestGetConsoleResponder,
    },
    GetSerial {
        responder: GuestGetSerialResponder,
    },
    GetHostVsockEndpoint {
        endpoint: ServerEnd<HostVsockEndpointMarker>,
        responder: GuestGetHostVsockEndpointResponder,
    },
    GetBalloonController {
        controller: ServerEnd<BalloonControllerMarker>,
        responder: GuestGetBalloonControllerResponder,
    },
    GetMemController {
        controller: ServerEnd<MemControllerMarker>,
        responder: GuestGetMemControllerResponder,
    },
}

The guest client API providing high level access to guest features. When the guest terminates, this channel will contain a ZX_OK epitaph on a clean shutdown, a ZX_ERR_INTERNAL epitaph on an unexpected shutdown, and no epitaph if the component crashed.

Variants

GetConsole

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.

Fields

responder: GuestGetConsoleResponder

GetSerial

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.

Fields

responder: GuestGetSerialResponder

GetHostVsockEndpoint

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.

Fields

endpoint: ServerEnd<HostVsockEndpointMarker>

responder: GuestGetHostVsockEndpointResponder

GetBalloonController

Get the balloon controller endpoint for the guest.

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

Fields

controller: ServerEnd<BalloonControllerMarker>

responder: GuestGetBalloonControllerResponder

GetMemController

Get the mem controller endpoint for the guest.

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

Fields

controller: ServerEnd<MemControllerMarker>

responder: GuestGetMemControllerResponder

Implementations

impl GuestRequest

pub fn into_get_console(self) -> Option<GuestGetConsoleResponder>

pub fn into_get_serial(self) -> Option<GuestGetSerialResponder>

pub fn into_get_host_vsock_endpoint( self, ) -> Option<(ServerEnd<HostVsockEndpointMarker>, GuestGetHostVsockEndpointResponder)>

pub fn into_get_balloon_controller( self, ) -> Option<(ServerEnd<BalloonControllerMarker>, GuestGetBalloonControllerResponder)>

pub fn into_get_mem_controller( self, ) -> Option<(ServerEnd<MemControllerMarker>, GuestGetMemControllerResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for GuestRequest

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

Formats the value using the given formatter.