Enum fidl_fuchsia_io::Node2Request

pub enum Node2Request {
    Close {
        responder: Node2CloseResponder,
    },
    Query {
        responder: Node2QueryResponder,
    },
    Reopen {
        rights_request: RightsRequest,
        object_request: ServerEnd<NodeMarker>,
        control_handle: Node2ControlHandle,
    },
    GetConnectionInfo {
        responder: Node2GetConnectionInfoResponder,
    },
    GetAttributes {
        query: NodeAttributesQuery,
        responder: Node2GetAttributesResponder,
    },
    UpdateAttributes {
        payload: MutableNodeAttributes,
        responder: Node2UpdateAttributesResponder,
    },
    Sync {
        responder: Node2SyncResponder,
    },
    ListExtendedAttributes {
        iterator: ServerEnd<ExtendedAttributeIteratorMarker>,
        control_handle: Node2ControlHandle,
    },
    GetExtendedAttribute {
        name: Vec<u8>,
        responder: Node2GetExtendedAttributeResponder,
    },
    SetExtendedAttribute {
        name: Vec<u8>,
        value: ExtendedAttributeValue,
        mode: SetExtendedAttributeMode,
        responder: Node2SetExtendedAttributeResponder,
    },
    RemoveExtendedAttribute {
        name: Vec<u8>,
        responder: Node2RemoveExtendedAttributeResponder,
    },
}

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

Variants

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: Node2CloseResponder

Query

Fields

responder: Node2QueryResponder

Reopen

Creates another connection to the same node.

Fields

rights_request: RightsRequest

object_request: ServerEnd<NodeMarker>

control_handle: Node2ControlHandle

GetConnectionInfo

Acquires information about the connection.

This method does not require any rights.

Fields

responder: Node2GetConnectionInfoResponder

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: Node2GetAttributesResponder

UpdateAttributes

Updates information about the node.

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

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

Fields

payload: MutableNodeAttributes

responder: Node2UpdateAttributesResponder

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: Node2SyncResponder

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: Node2ControlHandle

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: Node2GetExtendedAttributeResponder

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: Node2SetExtendedAttributeResponder

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: Node2RemoveExtendedAttributeResponder

Implementations

impl Node2Request

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

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

pub fn into_reopen( self ) -> Option<(RightsRequest, ServerEnd<NodeMarker>, Node2ControlHandle)>

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

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

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

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

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

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

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

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

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

Name of the method defined in FIDL

Trait Implementations

impl Debug for Node2Request

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

Formats the value using the given formatter.