Struct BlobWriterProxy

pub struct BlobWriterProxy { /* private fields */ }

Implementations

impl BlobWriterProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.fxfs/BlobWriter.

pub fn take_event_stream(&self) -> BlobWriterEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get_vmo( &self, size: u64, ) -> QueryResponseFut<BlobWriterGetVmoResult, DefaultFuchsiaResourceDialect>

Truncates the blob associated with this BlobWriter proxy to length size. Returns a handle to a vmo shared between the server and the client, which is implemented as a ring buffer. As the client writes blob contents into the vmo, it will call BytesReady to signal to the server that some number of bytes have been written.

Ring Buffer Semantics The server sets the size of the vmo passed back to the client. The chunks that the client writes are arbitrarily sized and do not have any alignment guarantees. Any particular write can wrap around the ring buffer. The client can have several outstanding BytesReady requests but the client is responsible for not overwriting a given range in the ring buffer until the BytesReady request corresponding to that range has completed.

pub fn bytes_ready( &self, bytes_written: u64, ) -> QueryResponseFut<BlobWriterBytesReadyResult, DefaultFuchsiaResourceDialect>

Indicates to the server that an additional bytes_written number of bytes have been written to the shared vmo and are ready to be read off the vmo and written to disk. The blob will be readable when the final BytesReady response is received by the client.

Trait Implementations

impl BlobWriterProxyInterface for BlobWriterProxy

type GetVmoResponseFut = QueryResponseFut<Result<Vmo, i32>>

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

fn get_vmo(&self, size: u64) -> Self::GetVmoResponseFut

fn bytes_ready(&self, bytes_written: u64) -> Self::BytesReadyResponseFut

impl Clone for BlobWriterProxy

fn clone(&self) -> BlobWriterProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlobWriterProxy

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

Formats the value using the given formatter.

impl Proxy for BlobWriterProxy

type Protocol = BlobWriterMarker

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.