pub struct DataSinkProxy { /* private fields */ }

Implementations§

source§

impl DataSinkProxy

source

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for DataSink

source

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.

source

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

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

source

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.

source

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.

source

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.

source

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

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

source

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.

source

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.

source

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

Flush all previously buffered writes to persistent storage.

Trait Implementations§

source§

impl Clone for DataSinkProxy

source§

fn clone(&self) -> DataSinkProxy

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl DataSinkProxyInterface for DataSinkProxy

§

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

source§

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

§

type WriteAssetResponseFut = QueryResponseFut<i32>

source§

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

§

type WriteFirmwareResponseFut = QueryResponseFut<WriteFirmwareResult>

source§

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

§

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

source§

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

§

type WriteVolumesResponseFut = QueryResponseFut<i32>

source§

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

§

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

source§

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

§

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

source§

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

§

type FlushResponseFut = QueryResponseFut<i32>

source§

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

source§

impl Debug for DataSinkProxy

source§

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

Formats the value using the given formatter. Read more
source§

impl Proxy for DataSinkProxy

§

type Protocol = DataSinkMarker

The protocol which this Proxy controls.
source§

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.
source§

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel. Read more
source§

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel. Read more
§

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.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more