Enum fidl_fuchsia_io::NodeRequest

pub enum NodeRequest {
    Clone2 {
        request: ServerEnd<CloneableMarker>,
        control_handle: NodeControlHandle,
    },
    Close {
        responder: NodeCloseResponder,
    },
    Query {
        responder: NodeQueryResponder,
    },
    Clone {
        flags: OpenFlags,
        object: ServerEnd<NodeMarker>,
        control_handle: NodeControlHandle,
    },
    GetAttr {
        responder: NodeGetAttrResponder,
    },
    SetAttr {
        flags: NodeAttributeFlags,
        attributes: NodeAttributes,
        responder: NodeSetAttrResponder,
    },
    GetFlags {
        responder: NodeGetFlagsResponder,
    },
    SetFlags {
        flags: OpenFlags,
        responder: NodeSetFlagsResponder,
    },
    QueryFilesystem {
        responder: NodeQueryFilesystemResponder,
    },
    GetConnectionInfo {
        responder: NodeGetConnectionInfoResponder,
    },
    GetAttributes {
        query: NodeAttributesQuery,
        responder: NodeGetAttributesResponder,
    },
    UpdateAttributes {
        payload: MutableNodeAttributes,
        responder: NodeUpdateAttributesResponder,
    },
    Sync {
        responder: NodeSyncResponder,
    },
    ListExtendedAttributes {
        iterator: ServerEnd<ExtendedAttributeIteratorMarker>,
        control_handle: NodeControlHandle,
    },
    GetExtendedAttribute {
        name: Vec<u8>,
        responder: NodeGetExtendedAttributeResponder,
    },
    SetExtendedAttribute {
        name: Vec<u8>,
        value: ExtendedAttributeValue,
        mode: SetExtendedAttributeMode,
        responder: NodeSetExtendedAttributeResponder,
    },
    RemoveExtendedAttribute {
        name: Vec<u8>,
        responder: NodeRemoveExtendedAttributeResponder,
    },
    _UnknownMethod {
        ordinal: u64,
        control_handle: NodeControlHandle,
        method_type: MethodType,
    },
}

Node defines the minimal interface for entities which can be accessed in a filesystem.

Variants

Clone2

Fields

request: ServerEnd<CloneableMarker>

control_handle: NodeControlHandle

Close

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.

Fields

responder: NodeCloseResponder

Query

Fields

responder: NodeQueryResponder

Clone

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.

Fields

flags: OpenFlags

object: ServerEnd<NodeMarker>

control_handle: NodeControlHandle

GetAttr

Acquires information about the node.

This method does not require any rights.

Fields

responder: NodeGetAttrResponder

SetAttr

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.

Fields

flags: NodeAttributeFlags

attributes: NodeAttributes

responder: NodeSetAttrResponder

GetFlags

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

This method does not require any rights.

Fields

responder: NodeGetFlagsResponder

SetFlags

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.

Fields

flags: OpenFlags

responder: NodeSetFlagsResponder

QueryFilesystem

Query the filesystem for filesystem-specific information.

Fields

responder: NodeQueryFilesystemResponder

GetConnectionInfo

Acquires information about the connection.

This method does not require any rights.

Fields

responder: NodeGetConnectionInfoResponder

GetAttributes

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.

Fields

query: NodeAttributesQuery

responder: NodeGetAttributesResponder

UpdateAttributes

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.

Fields

payload: MutableNodeAttributes

responder: NodeUpdateAttributesResponder

Sync

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.

Fields

responder: NodeSyncResponder

ListExtendedAttributes

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.

Fields

iterator: ServerEnd<ExtendedAttributeIteratorMarker>

control_handle: NodeControlHandle

GetExtendedAttribute

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.

Fields

name: Vec<u8>

responder: NodeGetExtendedAttributeResponder

SetExtendedAttribute

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.

Fields

name: Vec<u8>

value: ExtendedAttributeValue

mode: SetExtendedAttributeMode

responder: NodeSetExtendedAttributeResponder

RemoveExtendedAttribute

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.

Fields

name: Vec<u8>

responder: NodeRemoveExtendedAttributeResponder

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: NodeControlHandle

method_type: MethodType

Implementations

impl NodeRequest

pub fn into_clone2( self, ) -> Option<(ServerEnd<CloneableMarker>, NodeControlHandle)>

pub fn into_close(self) -> Option<NodeCloseResponder>

pub fn into_query(self) -> Option<NodeQueryResponder>

pub fn into_clone( self, ) -> Option<(OpenFlags, ServerEnd<NodeMarker>, NodeControlHandle)>

pub fn into_get_attr(self) -> Option<NodeGetAttrResponder>

pub fn into_set_attr( self, ) -> Option<(NodeAttributeFlags, NodeAttributes, NodeSetAttrResponder)>

pub fn into_get_flags(self) -> Option<NodeGetFlagsResponder>

pub fn into_set_flags(self) -> Option<(OpenFlags, NodeSetFlagsResponder)>

pub fn into_query_filesystem(self) -> Option<NodeQueryFilesystemResponder>

pub fn into_get_connection_info(self) -> Option<NodeGetConnectionInfoResponder>

pub fn into_get_attributes( self, ) -> Option<(NodeAttributesQuery, NodeGetAttributesResponder)>

pub fn into_update_attributes( self, ) -> Option<(MutableNodeAttributes, NodeUpdateAttributesResponder)>

pub fn into_sync(self) -> Option<NodeSyncResponder>

pub fn into_list_extended_attributes( self, ) -> Option<(ServerEnd<ExtendedAttributeIteratorMarker>, NodeControlHandle)>

pub fn into_get_extended_attribute( self, ) -> Option<(Vec<u8>, NodeGetExtendedAttributeResponder)>

pub fn into_set_extended_attribute( self, ) -> Option<(Vec<u8>, ExtendedAttributeValue, SetExtendedAttributeMode, NodeSetExtendedAttributeResponder)>

pub fn into_remove_extended_attribute( self, ) -> Option<(Vec<u8>, NodeRemoveExtendedAttributeResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for NodeRequest

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

Formats the value using the given formatter.