Struct fidl_fuchsia_io::NodeProxy
source · pub struct NodeProxy { /* private fields */ }
Implementations§
source§impl NodeProxy
impl NodeProxy
sourcepub fn take_event_stream(&self) -> NodeEventStream
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.
sourcepub fn clone(
&self,
flags: OpenFlags,
object: ServerEnd<NodeMarker>,
) -> Result<(), Error>
pub fn clone( &self, flags: OpenFlags, object: ServerEnd<NodeMarker>, ) -> Result<(), Error>
Create another connection to the same remote object.
flags
may be any of:
OpenFlags.RIGHT_*
OpenFlags.APPEND
OpenFlags.DESCRIBE
OpenFlags.CLONE_SAME_RIGHTS
All other flags are ignored.
The OpenFlags.RIGHT_*
bits in flags
request corresponding rights over the resulting
cloned object.
The cloned object must have rights less than or equal to the original object, otherwise
returns ZX_ERR_ACCESS_DENIED
.
Alternatively, pass OpenFlags.CLONE_SAME_RIGHTS
to inherit the rights on the source connection.
It is invalid to pass any of the OpenFlags.RIGHT_*
flags together with
OpenFlags.CLONE_SAME_RIGHTS
.
sourcepub fn get_attr(&self) -> QueryResponseFut<(i32, NodeAttributes)>
pub fn get_attr(&self) -> QueryResponseFut<(i32, NodeAttributes)>
Acquires information about the node.
This method does not require any rights.
sourcepub fn set_attr(
&self,
flags: NodeAttributeFlags,
attributes: &NodeAttributes,
) -> QueryResponseFut<i32>
pub fn set_attr( &self, flags: NodeAttributeFlags, attributes: &NodeAttributes, ) -> QueryResponseFut<i32>
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
.
sourcepub fn get_flags(&self) -> QueryResponseFut<(i32, OpenFlags)>
pub fn get_flags(&self) -> QueryResponseFut<(i32, OpenFlags)>
Acquires the Directory.Open
rights and flags used to access this file.
This method does not require any rights.
sourcepub fn set_flags(&self, flags: OpenFlags) -> QueryResponseFut<i32>
pub fn set_flags(&self, flags: OpenFlags) -> QueryResponseFut<i32>
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.
sourcepub fn query_filesystem(
&self,
) -> QueryResponseFut<(i32, Option<Box<FilesystemInfo>>)>
pub fn query_filesystem( &self, ) -> QueryResponseFut<(i32, Option<Box<FilesystemInfo>>)>
Query the filesystem for filesystem-specific information.
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.
Returns ZX_ERR_NOT_SUPPORTED
if the node does not support any of the specified attributes.
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 NodeProxyInterface for NodeProxy
impl NodeProxyInterface for NodeProxy
fn clone( &self, flags: OpenFlags, object: ServerEnd<NodeMarker>, ) -> Result<(), Error>
type GetAttrResponseFut = QueryResponseFut<(i32, NodeAttributes)>
fn get_attr(&self) -> Self::GetAttrResponseFut
type SetAttrResponseFut = QueryResponseFut<i32>
fn set_attr( &self, flags: NodeAttributeFlags, attributes: &NodeAttributes, ) -> Self::SetAttrResponseFut
type GetFlagsResponseFut = QueryResponseFut<(i32, OpenFlags)>
fn get_flags(&self) -> Self::GetFlagsResponseFut
type SetFlagsResponseFut = QueryResponseFut<i32>
fn set_flags(&self, flags: OpenFlags) -> Self::SetFlagsResponseFut
type QueryFilesystemResponseFut = QueryResponseFut<(i32, Option<Box<FilesystemInfo>>)>
fn query_filesystem(&self) -> Self::QueryFilesystemResponseFut
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 NodeProxy
impl Proxy for NodeProxy
§type Protocol = NodeMarker
type Protocol = NodeMarker
Proxy
controls.source§fn from_channel(inner: AsyncChannel) -> Self
fn from_channel(inner: AsyncChannel) -> Self
source§fn into_channel(self) -> Result<AsyncChannel, Self>
fn into_channel(self) -> Result<AsyncChannel, Self>
source§fn as_channel(&self) -> &AsyncChannel
fn as_channel(&self) -> &AsyncChannel
§fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>
fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>
Auto Trait Implementations§
impl Freeze for NodeProxy
impl !RefUnwindSafe for NodeProxy
impl Send for NodeProxy
impl Sync for NodeProxy
impl Unpin for NodeProxy
impl !UnwindSafe for NodeProxy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)