Skip to main content

DataSinkServerHandler

Trait DataSinkServerHandler 

Source
pub trait DataSinkServerHandler<___T: Transport = Channel> {
    // Required methods
    fn read_asset(
        &mut self,
        request: Request<ReadAsset, ___T>,
        responder: Responder<ReadAsset, ___T>,
    ) -> impl Future<Output = ()> + Send;
    fn write_asset(
        &mut self,
        request: Request<WriteAsset, ___T>,
        responder: Responder<WriteAsset, ___T>,
    ) -> impl Future<Output = ()> + Send;
    fn write_firmware(
        &mut self,
        request: Request<WriteFirmware, ___T>,
        responder: Responder<WriteFirmware, ___T>,
    ) -> impl Future<Output = ()> + Send;
    fn read_firmware(
        &mut self,
        request: Request<ReadFirmware, ___T>,
        responder: Responder<ReadFirmware, ___T>,
    ) -> impl Future<Output = ()> + Send;
    fn write_opaque_volume(
        &mut self,
        request: Request<WriteOpaqueVolume, ___T>,
        responder: Responder<WriteOpaqueVolume, ___T>,
    ) -> impl Future<Output = ()> + Send;
    fn write_sparse_volume(
        &mut self,
        request: Request<WriteSparseVolume, ___T>,
        responder: Responder<WriteSparseVolume, ___T>,
    ) -> impl Future<Output = ()> + Send;
    fn flush(
        &mut self,
        responder: Responder<Flush, ___T>,
    ) -> impl Future<Output = ()> + Send;
}
Expand description

A server handler for the DataSink protocol.

See DataSink for more details.

Required Methods§

Source

fn read_asset( &mut self, request: Request<ReadAsset, ___T>, responder: Responder<ReadAsset, ___T>, ) -> impl Future<Output = ()> + Send

Reads the partition corresponding to configuration and asset into a vmo and returns it. The size field of the returned Buffer will be the size of just the asset, if it can be determined. Otherwise, it will be the size of the entire partition. The size and stream size of the vmo in the returned Buffer will always be the size of the entire partition.

Source

fn write_asset( &mut self, request: Request<WriteAsset, ___T>, responder: Responder<WriteAsset, ___T>, ) -> impl Future<Output = ()> + Send

Writes partition corresponding to configuration and asset with data from payload. payload may need to be resized to the partition size, so the provided vmo must have been created with ZX_VMO_RESIZABLE or must be a child VMO that was created with ZX_VMO_CHILD_RESIZABLE. Will zero out rest of the partition if payload is smaller than the size of the partition being written.

Returns ZX_ERR_INVALID_ARGS if configuration specifies active configuration.

Source

fn write_firmware( &mut self, request: Request<WriteFirmware, ___T>, responder: Responder<WriteFirmware, ___T>, ) -> impl Future<Output = ()> + Send

Writes firmware data from payload.

configuration represents the A/B/R configuration. For platforms that do not support firmware A/B/R, the parameter will be ignored by the underlying device-specific logic .

type is a device-specific string identifying the payload contents, used to select the proper paving logic. For example, a device with multiple bootloader stages might send them as separate calls to WriteFirmware(), differentiated by type. An empty string indicates the default type.

payload may need to be resized to the partition size, so the provided vmo must have been created with ZX_VMO_RESIZABLE or must be a child VMO that was created with ZX_VMO_CHILD_RESIZABLE.

Source

fn read_firmware( &mut self, request: Request<ReadFirmware, ___T>, responder: Responder<ReadFirmware, ___T>, ) -> impl Future<Output = ()> + Send

Read firmware corresponding to configuration and type.

Parameter configuration and type are the same as WriteFirmware.

If ReadFirmware returns error, caller should assume that firmware image does not exist or is in a bad state, or firmware read is not defined for the product.

Source

fn write_opaque_volume( &mut self, request: Request<WriteOpaqueVolume, ___T>, responder: Responder<WriteOpaqueVolume, ___T>, ) -> impl Future<Output = ()> + Send

Write a raw volume image to the device. The image will be passed as it is to the device partitioner backend to write. Therefore the format and write logic for the image is up to the product to define. It differs from the legacy WriteVolume(), which was specifically for writing the FVM sparse image, in that the paver will not perform any FVM related parsing or other operation of the image. Thus it is not dependent on the volume driver version and less susceptible to an outdated paver.

Returns ZX_ERR_NOT_SUPPORTED if the backend does not support opaque volume blobs.

Source

fn write_sparse_volume( &mut self, request: Request<WriteSparseVolume, ___T>, responder: Responder<WriteSparseVolume, ___T>, ) -> impl Future<Output = ()> + Send

Writes an image in the Android Sparse format. Identical in behaviour to WriteOpaqueVolume, except the contents of payload are parsed as a sparse image and unpacked before being written to disk.

Source

fn flush( &mut self, responder: Responder<Flush, ___T>, ) -> impl Future<Output = ()> + Send

Flush all previously buffered writes to persistent storage.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§