Struct NodeProxy

pub struct NodeProxy { /* private fields */ }

Implementations

impl NodeProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.io/Node.

pub fn take_event_stream(&self) -> NodeEventStream

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

Panics

Panics if the event stream was already taken.

pub fn clone(&self, request: ServerEnd<CloneableMarker>) -> Result<(), Error>

pub fn close( &self, ) -> QueryResponseFut<CloseableCloseResult, DefaultFuchsiaResourceDialect>

Terminates the connection.

After calling Close, the client must not send any other requests.

Servers, after sending the status response, should close the connection regardless of status and without sending an epitaph.

Closing the client end of the channel should be semantically equivalent to calling Close without knowing when the close has completed or its status.

pub fn query(&self) -> QueryResponseFut<Vec<u8>, DefaultFuchsiaResourceDialect>

pub fn deprecated_clone( &self, flags: OpenFlags, object: ServerEnd<NodeMarker>, ) -> Result<(), Error>

pub fn get_attr( &self, ) -> QueryResponseFut<(i32, NodeAttributes), DefaultFuchsiaResourceDialect>

Acquires information about the node.

This method does not require any rights.

pub fn set_attr( &self, flags: NodeAttributeFlags, attributes: &NodeAttributes, ) -> QueryResponseFut<i32, DefaultFuchsiaResourceDialect>

Updates information about the node.

Returns ZX_ERR_NOT_SUPPORTED if any attributes specified by [flags] are not supported.

This method requires following rights: OpenFlags.RIGHT_WRITABLE, otherwise returns ZX_ERR_BAD_HANDLE.

pub fn get_flags( &self, ) -> QueryResponseFut<(i32, OpenFlags), DefaultFuchsiaResourceDialect>

Acquires the Directory.Open rights and flags used to access this file.

This method does not require any rights.

pub fn set_flags( &self, flags: OpenFlags, ) -> QueryResponseFut<i32, DefaultFuchsiaResourceDialect>

Changes the Directory.Open flags used to access the file. Supported flags which can be turned on / off:

• OpenFlags.APPEND

This method does not require any rights.

pub fn get_flags2( &self, ) -> QueryResponseFut<NodeGetFlags2Result, DefaultFuchsiaResourceDialect>

Queries the flags that apply to this node after it has been opened/created. This method does not require any rights.

Note that the final set of flags that apply to the connection may differ from those specified with the fuchsia.io/Directory.Open request used to create it:

• Flags.PERM_INHERIT_*: Only applies when determining connection rights.
• Flags.PROTOCOL_*: Only the protocol of the connection will be present.
• Flags.FLAG_*: Only applies when opening the resource, not part of the connection.

pub fn set_flags2( &self, flags: Flags, ) -> QueryResponseFut<NodeSetFlags2Result, DefaultFuchsiaResourceDialect>

Sets the flags that apply to this node after it has been opened. This method does not require any rights.

Only Flags.FILE_APPEND is currently supported. Calling this method without any flags will clear append mode.

Errors:

• ZX_ERR_NOT_SUPPORTED: The object does not support this feature or the specified flags.
• ZX_ERR_INVALID_ARGS: flags other than Flags.FILE_APPEND were specified.

pub fn query_filesystem( &self, ) -> QueryResponseFut<(i32, Option<Box<FilesystemInfo>>), DefaultFuchsiaResourceDialect>

Query the filesystem for filesystem-specific information.

pub fn get_connection_info( &self, ) -> QueryResponseFut<ConnectionInfo, DefaultFuchsiaResourceDialect>

Acquires information about the connection.

This method does not require any rights.

pub fn get_attributes( &self, query: NodeAttributesQuery, ) -> QueryResponseFut<NodeGetAttributesResult, DefaultFuchsiaResourceDialect>

Acquires information about the node.

The attributes of a node should be stable, independent of the specific protocol used to access it.

If a particular attribute is not applicable or not supported, filesystems should leave the corresponding field absent.

• query a bit-mask specifying which attributes to fetch. The server should not return more than necessary.

• attributes the returned attributes.

This method requires the [Rights.GET_ATTRIBUTES] right.

pub fn update_attributes( &self, payload: &MutableNodeAttributes, ) -> QueryResponseFut<NodeUpdateAttributesResult, DefaultFuchsiaResourceDialect>

Updates information about the node.

• attributes the presence of a table field in attributes indicates the intent to update the corresponding attribute.

Returns ZX_ERR_NOT_SUPPORTED if the node does not support any of the specified attributes.

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

pub fn sync( &self, ) -> QueryResponseFut<NodeSyncResult, DefaultFuchsiaResourceDialect>

Synchronizes updates to the node to the underlying media, if it exists.

This method will return when the filesystem server has flushed the relevant updates to the underlying media, but does not guarantee the underlying media has persisted the information, nor that any information is committed to hardware. Clients may use Sync to ensure ordering between operations.

This method does not require any rights.

pub fn list_extended_attributes( &self, iterator: ServerEnd<ExtendedAttributeIteratorMarker>, ) -> Result<(), Error>

Creates an iterator over all the extended attribute names associated with this node. If an error occurs it is returned as an epitaph on the iterator request channel, and then the channel is closed.

GetExtendedAttributes can be used with any of these names to retrieve the associated value.

This method requires the [Rights.GET_ATTRIBUTES] right.

pub fn get_extended_attribute( &self, name: &[u8], ) -> QueryResponseFut<NodeGetExtendedAttributeResult, DefaultFuchsiaResourceDialect>

Get the value associated with the given attribute name for this node.

Attribute names have a maximum length of MAX_ATTRIBUTE_NAME. No particular structure is imposed on them.

This method requires the [Rights.GET_ATTRIBUTES] right.

pub fn set_extended_attribute( &self, name: &[u8], value: ExtendedAttributeValue, mode: SetExtendedAttributeMode, ) -> QueryResponseFut<NodeSetExtendedAttributeResult, DefaultFuchsiaResourceDialect>

Set the value for the given attribute name to value for this node.

The attribute name may exist, in which case the attribute is updated. If the attribute doesn’t exist, it is created. The name should have no null bytes in it. If it does, ZX_ERR_INVALID_ARGS is returned.

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

pub fn remove_extended_attribute( &self, name: &[u8], ) -> QueryResponseFut<NodeRemoveExtendedAttributeResult, DefaultFuchsiaResourceDialect>

Remove the specified extended attribute.

If the attribute doesn’t exist, ZX_ERR_NOT_FOUND is returned.

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

Trait Implementations

impl Clone for NodeProxy

fn clone(&self) -> NodeProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeProxy

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

Formats the value using the given formatter.

impl NodeProxyInterface for NodeProxy

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

type QueryResponseFut = QueryResponseFut<Vec<u8>>

type GetAttrResponseFut = QueryResponseFut<(i32, NodeAttributes)>

type SetAttrResponseFut = QueryResponseFut<i32>

type GetFlagsResponseFut = QueryResponseFut<(i32, OpenFlags)>

type SetFlagsResponseFut = QueryResponseFut<i32>

type GetFlags2ResponseFut = QueryResponseFut<Result<Flags, i32>>

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

type QueryFilesystemResponseFut = QueryResponseFut<(i32, Option<Box<FilesystemInfo>>)>

type GetConnectionInfoResponseFut = QueryResponseFut<ConnectionInfo>

type GetAttributesResponseFut = QueryResponseFut<Result<(MutableNodeAttributes, ImmutableNodeAttributes), i32>>

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

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

type GetExtendedAttributeResponseFut = QueryResponseFut<Result<ExtendedAttributeValue, i32>>

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

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

fn clone(&self, request: ServerEnd<CloneableMarker>) -> Result<(), Error>

fn close(&self) -> Self::CloseResponseFut

fn query(&self) -> Self::QueryResponseFut

fn deprecated_clone( &self, flags: OpenFlags, object: ServerEnd<NodeMarker>, ) -> Result<(), Error>

fn get_attr(&self) -> Self::GetAttrResponseFut

fn set_attr( &self, flags: NodeAttributeFlags, attributes: &NodeAttributes, ) -> Self::SetAttrResponseFut

fn get_flags(&self) -> Self::GetFlagsResponseFut

fn set_flags(&self, flags: OpenFlags) -> Self::SetFlagsResponseFut

fn get_flags2(&self) -> Self::GetFlags2ResponseFut

fn set_flags2(&self, flags: Flags) -> Self::SetFlags2ResponseFut

fn query_filesystem(&self) -> Self::QueryFilesystemResponseFut

fn get_connection_info(&self) -> Self::GetConnectionInfoResponseFut

fn get_attributes( &self, query: NodeAttributesQuery, ) -> Self::GetAttributesResponseFut

fn update_attributes( &self, payload: &MutableNodeAttributes, ) -> Self::UpdateAttributesResponseFut

fn sync(&self) -> Self::SyncResponseFut

fn list_extended_attributes( &self, iterator: ServerEnd<ExtendedAttributeIteratorMarker>, ) -> Result<(), Error>

fn get_extended_attribute( &self, name: &[u8], ) -> Self::GetExtendedAttributeResponseFut

fn set_extended_attribute( &self, name: &[u8], value: ExtendedAttributeValue, mode: SetExtendedAttributeMode, ) -> Self::SetExtendedAttributeResponseFut

fn remove_extended_attribute( &self, name: &[u8], ) -> Self::RemoveExtendedAttributeResponseFut

impl Proxy for NodeProxy

type Protocol = NodeMarker

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.