Struct fidl_fuchsia_io::Node2Proxy
source · pub struct Node2Proxy { /* private fields */ }
Implementations§
source§impl Node2Proxy
impl Node2Proxy
sourcepub fn take_event_stream(&self) -> Node2EventStream
pub fn take_event_stream(&self) -> Node2EventStream
Get a Stream of events from the remote end of the protocol.
§Panics
Panics if the event stream was already taken.
sourcepub fn close(&self) -> QueryResponseFut<CloseableCloseResult>
pub fn close(&self) -> QueryResponseFut<CloseableCloseResult>
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>>
sourcepub fn reopen(
&self,
rights_request: &RightsRequest,
object_request: ServerEnd<NodeMarker>
) -> Result<(), Error>
pub fn reopen( &self, rights_request: &RightsRequest, object_request: ServerEnd<NodeMarker> ) -> Result<(), Error>
Creates another connection to the same node.
sourcepub fn get_connection_info(&self) -> QueryResponseFut<ConnectionInfo>
pub fn get_connection_info(&self) -> QueryResponseFut<ConnectionInfo>
Acquires information about the connection.
This method does not require any rights.
sourcepub fn get_attributes(
&self,
query: NodeAttributesQuery
) -> QueryResponseFut<Node2GetAttributesResult>
pub fn get_attributes( &self, query: NodeAttributesQuery ) -> QueryResponseFut<Node2GetAttributesResult>
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.
sourcepub fn update_attributes(
&self,
payload: &MutableNodeAttributes
) -> QueryResponseFut<Node2UpdateAttributesResult>
pub fn update_attributes( &self, payload: &MutableNodeAttributes ) -> QueryResponseFut<Node2UpdateAttributesResult>
Updates information about the node.
attributes
the presence of a table field inattributes
indicates the intent to update the corresponding attribute.
This method requires the [Rights.UPDATE_ATTRIBUTES
] right.
sourcepub fn sync(&self) -> QueryResponseFut<Node2SyncResult>
pub fn sync(&self) -> QueryResponseFut<Node2SyncResult>
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.
sourcepub fn list_extended_attributes(
&self,
iterator: ServerEnd<ExtendedAttributeIteratorMarker>
) -> Result<(), Error>
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.
sourcepub fn get_extended_attribute(
&self,
name: &[u8]
) -> QueryResponseFut<Node2GetExtendedAttributeResult>
pub fn get_extended_attribute( &self, name: &[u8] ) -> QueryResponseFut<Node2GetExtendedAttributeResult>
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.
sourcepub fn set_extended_attribute(
&self,
name: &[u8],
value: ExtendedAttributeValue,
mode: SetExtendedAttributeMode
) -> QueryResponseFut<Node2SetExtendedAttributeResult>
pub fn set_extended_attribute( &self, name: &[u8], value: ExtendedAttributeValue, mode: SetExtendedAttributeMode ) -> QueryResponseFut<Node2SetExtendedAttributeResult>
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.
sourcepub fn remove_extended_attribute(
&self,
name: &[u8]
) -> QueryResponseFut<Node2RemoveExtendedAttributeResult>
pub fn remove_extended_attribute( &self, name: &[u8] ) -> QueryResponseFut<Node2RemoveExtendedAttributeResult>
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§
source§impl Clone for Node2Proxy
impl Clone for Node2Proxy
source§fn clone(&self) -> Node2Proxy
fn clone(&self) -> Node2Proxy
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Node2Proxy
impl Debug for Node2Proxy
source§impl Node2ProxyInterface for Node2Proxy
impl Node2ProxyInterface for Node2Proxy
type CloseResponseFut = QueryResponseFut<Result<(), i32>>
fn close(&self) -> Self::CloseResponseFut
type QueryResponseFut = QueryResponseFut<Vec<u8>>
fn query(&self) -> Self::QueryResponseFut
fn reopen( &self, rights_request: &RightsRequest, object_request: ServerEnd<NodeMarker> ) -> Result<(), Error>
type GetConnectionInfoResponseFut = QueryResponseFut<ConnectionInfo>
fn get_connection_info(&self) -> Self::GetConnectionInfoResponseFut
type GetAttributesResponseFut = QueryResponseFut<Result<(MutableNodeAttributes, ImmutableNodeAttributes), i32>>
fn get_attributes( &self, query: NodeAttributesQuery ) -> Self::GetAttributesResponseFut
type UpdateAttributesResponseFut = QueryResponseFut<Result<(), i32>>
fn update_attributes( &self, payload: &MutableNodeAttributes ) -> Self::UpdateAttributesResponseFut
type SyncResponseFut = QueryResponseFut<Result<(), i32>>
fn sync(&self) -> Self::SyncResponseFut
fn list_extended_attributes( &self, iterator: ServerEnd<ExtendedAttributeIteratorMarker> ) -> Result<(), Error>
type GetExtendedAttributeResponseFut = QueryResponseFut<Result<ExtendedAttributeValue, i32>>
fn get_extended_attribute( &self, name: &[u8] ) -> Self::GetExtendedAttributeResponseFut
type SetExtendedAttributeResponseFut = QueryResponseFut<Result<(), i32>>
fn set_extended_attribute( &self, name: &[u8], value: ExtendedAttributeValue, mode: SetExtendedAttributeMode ) -> Self::SetExtendedAttributeResponseFut
type RemoveExtendedAttributeResponseFut = QueryResponseFut<Result<(), i32>>
fn remove_extended_attribute( &self, name: &[u8] ) -> Self::RemoveExtendedAttributeResponseFut
source§impl Proxy for Node2Proxy
impl Proxy for Node2Proxy
§type Protocol = Node2Marker
type Protocol = Node2Marker
Proxy
controls.