Struct fidl_fuchsia_paver::DataSinkProxy

pub struct DataSinkProxy { /* private fields */ }

Implementations

impl DataSinkProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for DataSink

pub fn take_event_stream(&self) -> DataSinkEventStream

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

Panics

Panics if the event stream was already taken.

pub fn read_asset( &self, configuration: Configuration, asset: Asset ) -> QueryResponseFut<DataSinkReadAssetResult>

Reads partition corresponding to configuration and asset into a vmo and returns it.

pub fn write_asset( &self, configuration: Configuration, asset: Asset, payload: &mut Buffer ) -> QueryResponseFut<i32>

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.

pub fn write_firmware( &self, configuration: Configuration, type_: &str, payload: &mut Buffer ) -> QueryResponseFut<WriteFirmwareResult>

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.

pub fn read_firmware( &self, configuration: Configuration, type_: &str ) -> QueryResponseFut<DataSinkReadFirmwareResult>

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.

pub fn write_volumes( &self, payload: ClientEnd<PayloadStreamMarker> ) -> QueryResponseFut<i32>

Writes FVM with data from streamed via payload. This potentially affects all configurations.

pub fn write_opaque_volume( &self, payload: &mut Buffer ) -> QueryResponseFut<DataSinkWriteOpaqueVolumeResult>

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 WriteVolume(), which is 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.

pub fn wipe_volume(&self) -> QueryResponseFut<DataSinkWipeVolumeResult>

Wipes the FVM partition from the device. Should not be confused with factory reset, which is less intrusive. The result is that the default FVM volumes are re-created, but empty.

Notable use cases include recovering from corrupted FVM as well as setting device to a “clean” state for automation.

If block_device is not provided, the paver will perform a search for the the FVM. If multiple block devices have valid GPT, block_device can be provided to specify which one to target. It assumed that channel backing block_device also implements fuchsia.io.Node for now.

On success, returns a channel to the initialized FVM volume.

pub fn flush(&self) -> QueryResponseFut<i32>

Flush all previously buffered writes to persistent storage.

Trait Implementations

impl Clone for DataSinkProxy

fn clone(&self) -> DataSinkProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSinkProxyInterface for DataSinkProxy

type ReadAssetResponseFut = QueryResponseFut<Result<Buffer, i32>>

fn read_asset( &self, configuration: Configuration, asset: Asset ) -> Self::ReadAssetResponseFut

type WriteAssetResponseFut = QueryResponseFut<i32>

fn write_asset( &self, configuration: Configuration, asset: Asset, payload: &mut Buffer ) -> Self::WriteAssetResponseFut

type WriteFirmwareResponseFut = QueryResponseFut<WriteFirmwareResult>

fn write_firmware( &self, configuration: Configuration, type_: &str, payload: &mut Buffer ) -> Self::WriteFirmwareResponseFut

type ReadFirmwareResponseFut = QueryResponseFut<Result<Buffer, i32>>

fn read_firmware( &self, configuration: Configuration, type_: &str ) -> Self::ReadFirmwareResponseFut

type WriteVolumesResponseFut = QueryResponseFut<i32>

fn write_volumes( &self, payload: ClientEnd<PayloadStreamMarker> ) -> Self::WriteVolumesResponseFut

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

fn write_opaque_volume( &self, payload: &mut Buffer ) -> Self::WriteOpaqueVolumeResponseFut

type WipeVolumeResponseFut = QueryResponseFut<Result<ClientEnd<VolumeManagerMarker>, i32>>

fn wipe_volume(&self) -> Self::WipeVolumeResponseFut

type FlushResponseFut = QueryResponseFut<i32>

fn flush(&self) -> Self::FlushResponseFut

impl Debug for DataSinkProxy

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

Formats the value using the given formatter.

impl Proxy for DataSinkProxy

type Protocol = DataSinkMarker

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 is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed<'a>(&'a self) -> OnSignals<'a>

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