Struct fidl_fuchsia_io::AdvisoryLockingProxy

pub struct AdvisoryLockingProxy { /* private fields */ }

Implementations

impl AdvisoryLockingProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.io/AdvisoryLocking.

pub fn take_event_stream(&self) -> AdvisoryLockingEventStream

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

Panics

Panics if the event stream was already taken.

pub fn advisory_lock( &self, request: &AdvisoryLockRequest ) -> QueryResponseFut<AdvisoryLockingAdvisoryLockResult>

Acquires an advisory lock on the underlying file.

The lock lasts until either this connection is closed or this method is called with |AdvisoryLockType.UNLOCK| to release the lock explicitly.

Advisory locks are purely advisory. They do not prevent actual read or write operations from occurring on the file, either through this connection or through other connections.

This method requires the following rights:

• [Rights.READ_BYTES] if request.type is [AdvisoryLockType.READ].
• [Rights.WRITE_BYTES] if request.type is [AdvisoryLockType.WRITE].

Errors

• ZX_ERR_BAD_STATE The specified type of lock cannot be acquired. For example, another connection might hold a conflicting lock type.
• ZX_ERR_NOT_SUPPORTED This file does not support advisory locking.
• ZX_ERR_ACCESS_DENIED This connection does not have sufficient rights to acquire the given type of lock.

Trait Implementations

impl AdvisoryLockingProxyInterface for AdvisoryLockingProxy

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

fn advisory_lock( &self, request: &AdvisoryLockRequest ) -> Self::AdvisoryLockResponseFut

impl Clone for AdvisoryLockingProxy

fn clone(&self) -> AdvisoryLockingProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdvisoryLockingProxy

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

Formats the value using the given formatter.

impl Proxy for AdvisoryLockingProxy

type Protocol = AdvisoryLockingMarker

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.