Library Overview

PROTOCOLS

Debuglog

Defined in fuchsia.io2/debuglog.fidl

A node for interacting with the kernel debug log. It may be manipulated via the debuglog object returned from the DebuglogInfo member in Representation.

Close

Terminates the connection to the node.

After calling Close, the client must not send any other requests. The result of Close arrives as an epitaph, where the channel is closed by the server upon processing this operation.

Closing the client end of the channel should be semantically equivalent to calling Close without monitoring the status epitaph.

This method does not require any rights.

Request

Describe

Returns extra connection information and auxiliary handles.

• query specifies the fields in ConnectionInfo that the caller is interested in.

• info see ConnectionInfo for details on the fields.

When all known bits in query are set, the return value matches the one from OnConnectionInfo, as if the caller requested that event using ConnectionFlags.GET_CONNECTION_INFO.

If the Describe operation fails, the connection is closed with the associated error.

This method does not require any rights.

Request

Response

GetAttributes

Acquires information about the node.

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

• 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.

Request

Response

GetToken

Acquires a token which can be used to identify this connection at a later point in time.

This method does not require any rights. Note that the token identifies the connection, hence carries the rights information on this connection.

Request

Response

OnConnectionInfo

An event produced eagerly by the server if requested by ConnectionFlags.GET_CONNECTION_INFO. This event will be the first message from the server, and is sent exactly once.

• info See ConnectionInfo for details on the fields. All members should be present.

Different from fuchsia.io/OnOpen, an error during open/reopen is always manifested as an epitaph.

Response

Reopen

Creates another connection to the same node.

• options options applicable to both Open and Reopen, including negotiating protocol and restricting rights. See ConnectionOptions.
• object_request is the server end of a channel created for the new connection. The caller may proceed to send messages on the corresponding client end right away.

For files, the cloned connection and the original connection have independent seek offsets.

Request

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.

Request

Response

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.

Request

Response

Directory

Defined in fuchsia.io2/directory.fidl

A Node that is capable of containing other nodes.

Close

Terminates the connection to the node.

After calling Close, the client must not send any other requests. The result of Close arrives as an epitaph, where the channel is closed by the server upon processing this operation.

Closing the client end of the channel should be semantically equivalent to calling Close without monitoring the status epitaph.

This method does not require any rights.

Request

Describe

Returns extra connection information and auxiliary handles.

• query specifies the fields in ConnectionInfo that the caller is interested in.

• info see ConnectionInfo for details on the fields.

When all known bits in query are set, the return value matches the one from OnConnectionInfo, as if the caller requested that event using ConnectionFlags.GET_CONNECTION_INFO.

If the Describe operation fails, the connection is closed with the associated error.

This method does not require any rights.

Request

Response

Enumerate

Initiates a directory listing operation over the input channel, starting at seek offset 0.

This method requires the Rights.ENUMERATE right. If this right is absent, iterator will be closed with a ZX_ERR_ACCESS_DENIED epitaph.

Request

GetAttributes

Acquires information about the node.

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

• 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.

Request

Response

GetToken

Acquires a token which can be used to identify this connection at a later point in time.

This method does not require any rights. Note that the token identifies the connection, hence carries the rights information on this connection.

Request

Response

Link

Creates a link to a node named src by the name dst, in a directory represented by dst_parent_token.

Directories cannot be linked, to prevent reference cycles.

src and dst must be valid node names. See Name for what constitutes a valid name.

This method requires the following rights on both the current connection, and the connection identified by dst_parent_token:

• Rights.ENUMERATE

• Rights.MODIFY_DIRECTORY

• error ZX_ERR_INVALID_ARGS if src or dst is invalid.

• error ZX_ERR_INVALID_ARGS if src is a directory.

Request

Response

OnConnectionInfo

An event produced eagerly by the server if requested by ConnectionFlags.GET_CONNECTION_INFO. This event will be the first message from the server, and is sent exactly once.

• info See ConnectionInfo for details on the fields. All members should be present.

Different from fuchsia.io/OnOpen, an error during open/reopen is always manifested as an epitaph.

Response

Open

Opens or creates a new node relative to this directory node.

• path identifies the node to open. If path contains multiple segments, then the directory is traversed, one segment at a time, relative to the directory represented by this connection. See Path for what constitutes a valid path. To open another connection to the current directory, use Node.Reopen instead.
• mode controls whether to open existing/create new etc.
• options additional options applicable to both Open and Reopen, including negotiating protocol and restricting rights. See ConnectionOptions.
• object_request is the server end of a channel created for the new connection. The caller may proceed to send messages on the corresponding client end right away.

This method requires the following rights on the current connection:

• Rights.ENUMERATE
• Rights.TRAVERSE

Errors are presented as an epitaph on the object_request channel.

• error ZX_ERR_ACCESS_DENIED if the requested rights exceeds what is allowed.
• error ZX_ERR_BAD_PATH if path is invalid.

Request

Rename

Renames a node named src to the name dst, in a directory represented by dst_parent_token.

src and dst must be valid node names. See Name for what constitutes a valid name.

This method requires the following rights on both the current connection, and the connection identified by dst_parent_token:

• Rights.ENUMERATE

• Rights.MODIFY_DIRECTORY

• error ZX_ERR_INVALID_ARGS if src or dst is invalid.

Request

Response

Reopen

Creates another connection to the same node.

• options options applicable to both Open and Reopen, including negotiating protocol and restricting rights. See ConnectionOptions.
• object_request is the server end of a channel created for the new connection. The caller may proceed to send messages on the corresponding client end right away.

For files, the cloned connection and the original connection have independent seek offsets.

Request

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.

Request

Response

Unlink

Removes a child node from the this directory's list of entries.

Note: this does not guarantee that the underlying object is destroyed. Although the link will be removed from the containing directory, objects with multiple references (such as files which are still open) will not actually be destroyed until all references are closed.

• path identifies the node to be detached. If path contains multiple segments, then the directory is traversed, one segment at a time, relative to the directory represented by this connection.

• error ZX_ERR_ACCESS_DENIED if the connection does not have Rights.WRITE_BYTES.
• error ZX_ERR_NOT_SUPPORTED if the underlying filesystem does not support writing.
• error ZX_ERR_BAD_PATH if path is invalid.
• error ZX_ERR_NOT_EMPTY if path refers to a non-empty directory.
• error ZX_ERR_UNAVAILABLE if path refers to a mount point, containing a remote channel.

Other errors may be returned for filesystem-specific reasons.

This method requires the following rights:

• Rights.ENUMERATE
• Rights.MODIFY_DIRECTORY

Request

Response

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.

Request

Response

Watch

Watches a directory, monitoring events for children being added or removed on the server end of the watcher channel.

Mask specifies a bit mask of events to observe.

This method requires the Rights.ENUMERATE right. If this right is absent, watcher will be closed with a ZX_ERR_ACCESS_DENIED epitaph.

Request

DirectoryIterator

Defined in fuchsia.io2/directory-iterator.fidl

GetNext

Reads a collection of variably sized directory entries into a buffer.

The number of entries in a directory may be very large: akin to calling read multiple times on a file, directories have a seek offset which is updated on subsequent calls to Enumerate. The caller should always use a receiving buffer size as large as the maximum channel limit.

When the end of iteration is reached, the returned entries vector will be empty.

This method does not require any rights, as the rights are checked in the Directory.Enumerate call.

Request

Response

DirectoryWatcher

Defined in fuchsia.io2/directory-watcher.fidl

DirectoryWatcher transmits messages from a filesystem server about events happening in the filesystem. Clients can register new watchers using the Directory.Watch method, where they can filter which events they want to receive notifications for.

GetNext

A hanging get to obtain the next batch of events.

The caller should always use a receiving buffer size as large as the maximum channel limit.

Clients should attempt to maintain one in-flight GetNext call as much as possible. If GetNext is not constantly polled, the filesystem server might hit an upper limit on the number of buffered events, resulting in dropping. Should this happen, the connection will be closed with a ZX_ERR_IO_OVERRUN epitaph.

When the watched directory is deleted, this connection will be closed with a ZX_ERR_UNAVAILABLE epitaph. When the filesystem server is dying, this connection will be closed with a ZX_ERR_PEER_CLOSED epitaph.

Request

Response

File

Defined in fuchsia.io2/file.fidl

A Node which contains a sequence of bytes of definite length.

Close

Terminates the connection to the node.

After calling Close, the client must not send any other requests. The result of Close arrives as an epitaph, where the channel is closed by the server upon processing this operation.

Closing the client end of the channel should be semantically equivalent to calling Close without monitoring the status epitaph.

This method does not require any rights.

Request

Describe

Returns extra connection information and auxiliary handles.

• query specifies the fields in ConnectionInfo that the caller is interested in.

• info see ConnectionInfo for details on the fields.

When all known bits in query are set, the return value matches the one from OnConnectionInfo, as if the caller requested that event using ConnectionFlags.GET_CONNECTION_INFO.

If the Describe operation fails, the connection is closed with the associated error.

This method does not require any rights.

Request

Response

GetAttributes

Acquires information about the node.

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

• 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.

Request

Response

GetMemRange

Acquires a fuchsia.mem/Range representing this file, if there is one, with the requested access rights.

• request flags a VmoFlags indicating the desired mode of access.

• response buffer the requested fuchsia.mem/Range.

• error a zx.status value indicating the failure.

This method requires the following rights:

• Rights.READ_BYTES if flags includes VmoFlags.READ.
• Rights.WRITE_BYTES if flags includes VmoFlags.WRITE.
• Rights.EXECUTE if flags includes VmoFlags.EXECUTE.

Request

Response

GetToken

Acquires a token which can be used to identify this connection at a later point in time.

This method does not require any rights. Note that the token identifies the connection, hence carries the rights information on this connection.

Request

Response

OnConnectionInfo

An event produced eagerly by the server if requested by ConnectionFlags.GET_CONNECTION_INFO. This event will be the first message from the server, and is sent exactly once.

• info See ConnectionInfo for details on the fields. All members should be present.

Different from fuchsia.io/OnOpen, an error during open/reopen is always manifested as an epitaph.

Response

Read

Reads up to 'count' bytes at the seek offset. The seek offset is moved forward by the number of bytes read.

Invariants

• The returned data.length will never be greater than count.
• If data.length is less than count, it means that the seek offset has reached the end of file as part of this operation.
• If data.length is zero while count is not, it means that the seek offset is already at or beyond the end of file, and no data could be read.
• If count is zero, the server should perform all the checks ensuring read access without actually read anything, and return an empty data vector.

This method requires the Rights.READ_BYTES right.

Request

Response

ReadAt

Reads up to 'count' bytes at the provided offset. Does not affect the seek offset.

Invariants

• The returned data.length will never be greater than count.
• If data.length is less than count, it means that ReadAt has hit the end of file as part of this operation.
• If data.length is zero while count is not, it means that offset is at or past the end of file, and no data can be read.
• If count is zero, the server should perform all the checks ensuring read access without actually reading anything, and return an empty data vector.

This method requires the Rights.READ_BYTES right.

Request

Response

Reopen

Creates another connection to the same node.

• options options applicable to both Open and Reopen, including negotiating protocol and restricting rights. See ConnectionOptions.
• object_request is the server end of a channel created for the new connection. The caller may proceed to send messages on the corresponding client end right away.

For files, the cloned connection and the original connection have independent seek offsets.

Request

Resize

Shrinks or grows the file size to 'length' bytes.

If file size is reduced by this operation, the extra trailing data' is discarded. If file size is increased by this operation, the extended area appears as if it was zeroed.

This method requires the Rights.WRITE_BYTES right.

Request

Response

Seek

Moves the offset at which the next invocation of Read or Write will occur. The seek offset is specific to each file connection.

• request origin the reference point where offset will be based on.
• request offset the number of bytes to seek.

• response offset_from_start the adjusted seek offset, from the start of the file.

This method does not require any rights.

Request

Response

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.

Request

Response

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.

Request

Response

Write

Writes data at the seek offset. The seek offset is moved forward by the number of bytes written. If the file is in append mode, the seek offset is first set to the end of the file, followed by the write, in one atomic step.

The file size may grow if the seek offset plus data.length is beyond the current end of file.

• request data the byte buffer to write to the file.

• response actual_count the number of bytes written.

Invariants

• The returned actual_count will never be greater than data.length.
• If the server is unable to write all the data due to e.g. not enough space, actual_count may be less than data.length.
• If data.length is zero, the server should perform all the checks ensuring write access without mutating the file. The seek offset is still updated if in append mode.

This method requires the Rights.WRITE_BYTES right.

Request

Response

WriteAt

Writes data at the provided offset. Does not affect the seek offset.

The file size may grow if offset plus data.length is past the current end of file.

• request data the byte buffer to write to the file.
• request offset the offset from start of the file to begin writing.

• response actual_count the number of bytes written.

Invariants

• The returned actual_count will never be greater than data.length.
• If the server is unable to write all the data due to e.g. not enough space, actual_count may be less than data.length.
• If data.length is zero, the server should perform all the checks ensuring write access without mutating the file.

This method requires the Rights.WRITE_BYTES right.

Request

Response

Memory

Defined in fuchsia.io2/memory.fidl

A file-like node backed by a VMO. No memory-specific methods are provided by this protocol. The client should access it via the the MemoryInfo.buffer object in Representation.

Close

Terminates the connection to the node.

After calling Close, the client must not send any other requests. The result of Close arrives as an epitaph, where the channel is closed by the server upon processing this operation.

Closing the client end of the channel should be semantically equivalent to calling Close without monitoring the status epitaph.

This method does not require any rights.

Request

Describe

Returns extra connection information and auxiliary handles.

• query specifies the fields in ConnectionInfo that the caller is interested in.

• info see ConnectionInfo for details on the fields.

When all known bits in query are set, the return value matches the one from OnConnectionInfo, as if the caller requested that event using ConnectionFlags.GET_CONNECTION_INFO.

If the Describe operation fails, the connection is closed with the associated error.

This method does not require any rights.

Request

Response

GetAttributes

Acquires information about the node.

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

• 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.

Request

Response

GetToken

Acquires a token which can be used to identify this connection at a later point in time.

This method does not require any rights. Note that the token identifies the connection, hence carries the rights information on this connection.

Request

Response

OnConnectionInfo

An event produced eagerly by the server if requested by ConnectionFlags.GET_CONNECTION_INFO. This event will be the first message from the server, and is sent exactly once.

• info See ConnectionInfo for details on the fields. All members should be present.

Different from fuchsia.io/OnOpen, an error during open/reopen is always manifested as an epitaph.

Response

Reopen

Creates another connection to the same node.

• options options applicable to both Open and Reopen, including negotiating protocol and restricting rights. See ConnectionOptions.
• object_request is the server end of a channel created for the new connection. The caller may proceed to send messages on the corresponding client end right away.

For files, the cloned connection and the original connection have independent seek offsets.

Request

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.

Request

Response

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.

Request

Response

Node

Defined in fuchsia.io2/node.fidl

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

Close

Terminates the connection to the node.

After calling Close, the client must not send any other requests. The result of Close arrives as an epitaph, where the channel is closed by the server upon processing this operation.

Closing the client end of the channel should be semantically equivalent to calling Close without monitoring the status epitaph.

This method does not require any rights.

Request

Describe

Returns extra connection information and auxiliary handles.

• query specifies the fields in ConnectionInfo that the caller is interested in.

• info see ConnectionInfo for details on the fields.

When all known bits in query are set, the return value matches the one from OnConnectionInfo, as if the caller requested that event using ConnectionFlags.GET_CONNECTION_INFO.

If the Describe operation fails, the connection is closed with the associated error.

This method does not require any rights.

Request

Response

GetAttributes

Acquires information about the node.

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

• 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.

Request

Response

GetToken

Acquires a token which can be used to identify this connection at a later point in time.

This method does not require any rights. Note that the token identifies the connection, hence carries the rights information on this connection.

Request

Response

OnConnectionInfo

An event produced eagerly by the server if requested by ConnectionFlags.GET_CONNECTION_INFO. This event will be the first message from the server, and is sent exactly once.

• info See ConnectionInfo for details on the fields. All members should be present.

Different from fuchsia.io/OnOpen, an error during open/reopen is always manifested as an epitaph.

Response

Reopen

Creates another connection to the same node.

• options options applicable to both Open and Reopen, including negotiating protocol and restricting rights. See ConnectionOptions.
• object_request is the server end of a channel created for the new connection. The caller may proceed to send messages on the corresponding client end right away.

For files, the cloned connection and the original connection have independent seek offsets.

Request

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.

Request

Response

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.

Request

Response

Pipe

Defined in fuchsia.io2/pipe.fidl

A node for streaming unstructured data. No pipe-specific methods are provided by this protocol. The client should access the pipe via the socket object returned from the PipeInfo member in Representation.

Close

Terminates the connection to the node.

After calling Close, the client must not send any other requests. The result of Close arrives as an epitaph, where the channel is closed by the server upon processing this operation.

Closing the client end of the channel should be semantically equivalent to calling Close without monitoring the status epitaph.

This method does not require any rights.

Request

Describe

Returns extra connection information and auxiliary handles.

• query specifies the fields in ConnectionInfo that the caller is interested in.

• info see ConnectionInfo for details on the fields.

When all known bits in query are set, the return value matches the one from OnConnectionInfo, as if the caller requested that event using ConnectionFlags.GET_CONNECTION_INFO.

If the Describe operation fails, the connection is closed with the associated error.

This method does not require any rights.

Request

Response

GetAttributes

Acquires information about the node.

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

• 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.

Request

Response

GetToken

Acquires a token which can be used to identify this connection at a later point in time.

This method does not require any rights. Note that the token identifies the connection, hence carries the rights information on this connection.

Request

Response

OnConnectionInfo

An event produced eagerly by the server if requested by ConnectionFlags.GET_CONNECTION_INFO. This event will be the first message from the server, and is sent exactly once.

• info See ConnectionInfo for details on the fields. All members should be present.

Different from fuchsia.io/OnOpen, an error during open/reopen is always manifested as an epitaph.

Response

Reopen

Creates another connection to the same node.

• options options applicable to both Open and Reopen, including negotiating protocol and restricting rights. See ConnectionOptions.
• object_request is the server end of a channel created for the new connection. The caller may proceed to send messages on the corresponding client end right away.

For files, the cloned connection and the original connection have independent seek offsets.

Request

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.

Request

Response

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.

Request

Response

STRUCTS

DirectoryIterator_GetNext_Response

Defined in fuchsia.io2/directory-iterator.fidl

Directory_Link_Response

Defined in fuchsia.io2/directory.fidl

Directory_Rename_Response

Defined in fuchsia.io2/directory.fidl

Directory_Unlink_Response

Defined in fuchsia.io2/directory.fidl

File_GetMemRange_Response

Defined in fuchsia.io2/file.fidl

File_ReadAt_Response

Defined in fuchsia.io2/file.fidl

File_Read_Response

Defined in fuchsia.io2/file.fidl

File_Resize_Response

Defined in fuchsia.io2/file.fidl

File_Seek_Response

Defined in fuchsia.io2/file.fidl

File_WriteAt_Response

Defined in fuchsia.io2/file.fidl

File_Write_Response

Defined in fuchsia.io2/file.fidl

IdleEvent

Defined in fuchsia.io2/directory-watcher.fidl

Node_GetAttributes_Response

Defined in fuchsia.io2/node.fidl

Node_GetToken_Response

Defined in fuchsia.io2/node.fidl

Node_Sync_Response

Defined in fuchsia.io2/node.fidl

Node_UpdateAttributes_Response

Defined in fuchsia.io2/node.fidl

RightsRequest

Defined in fuchsia.io2/connection-options.fidl

Options for requesting rights on the new connection. Because opening a new connection may involve multiple hops through directory proxies, we require the client to set an upper bound and lower bound on the rights request, and intermediate proxies to refine these bounds.

The rights manipulation should be implemented mechanically without knowledge of any specific rights, and servers should propagate unknown bits members, to gracefully handle future rights extensions.

Implementation Notes

It could be common for a client to request an exact set of rights. We recommend client libraries to define a helper function like follows:

fn Exact(exact_rights: Rights) -> RightsRequest {
    RightsRequest {
        at_most: exact_rights,
        at_least: exact_rights,
        resolution: RightsResolution.MAXIMIZE,
    }
}

at_most ⊋ {}
at_most ⊃ at_least
rights_on_connection_where_open_is_received ⊋ {}
rights_on_connection_where_open_is_received ⊃ at_least

ENUMS

OpenMode

Type: uint32

Defined in fuchsia.io2/directory.fidl

Options related to node creation during Directory.Open.

RightsResolution

Type: uint32

Defined in fuchsia.io2/connection-options.fidl

When an Open/Reopen request reaches its final remote server, it should assign rights on the new connection based on one of these modes.

SeekOrigin

Type: uint32

Defined in fuchsia.io2/file.fidl

The reference point for updating the seek offset. See File.Seek.

This enum matches the zx_stream_seek_origin_t enum.

TABLES

ConnectionInfo

Defined in fuchsia.io2/connection-info.fidl

Returns run-time information about a node that is specific to the current connection.

ConnectionOptions

Defined in fuchsia.io2/connection-options.fidl

Options for Directory.Open and Node.Reopen.

RightsRequest {
    at_most: r,
    at_least: 0,
    resolution: RightsResolution.MAXIMIZE,
}

ConnectorInfo

Defined in fuchsia.io2/connector.fidl

Auxiliary data for the connector representation of a node, used for protocol discovery and connection.

It supports connecting to arbitrary protocols exported by the filesystem server at a path, including ones that do not compose Node.

DebuglogInfo

Defined in fuchsia.io2/debuglog.fidl

The debuglog representation of a node. The selection of this variant in Representation implies that the connection speaks the Debuglog protocol.

DeviceInfo

Defined in fuchsia.io2/deprecated.fidl

The object may be cast to the shared interface of devices.

DirectoryEntry

Defined in fuchsia.io2/directory-entry.fidl

Information about an immediate child node of a directory.

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

DirectoryEnumerateOptions

Defined in fuchsia.io2/directory-iterator.fidl

Options to pass to Directory.Enumerate.

DirectoryInfo

Defined in fuchsia.io2/directory.fidl

Auxiliary data for the directory representation of a node. The selection of this variant in Representation implies that the connection speaks the Directory protocol.

DirectoryWatchOptions

Defined in fuchsia.io2/directory-watcher.fidl

FileInfo

Defined in fuchsia.io2/file.fidl

Auxiliary data for the file representation of a node. The selection of this variant in Representation implies that the connection speaks the File protocol.

MemoryInfo

Defined in fuchsia.io2/memory.fidl

Auxiliary data for the memory object representation of a node. The node is a file which is represented as a VMO. The selection of this variant in Representation implies that the connection speaks the Memory protocol.

NodeAttributes

Defined in fuchsia.io2/node-attributes.fidl

Objective information about a filesystem node. See Node.GetAttributes and Node.UpdateAttributes.

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.

PipeInfo

Defined in fuchsia.io2/pipe.fidl

The pipe representation of a node. A pipe is a data streaming interface, commonly used for standard in/out. There is no universal requirement as to if it is uni- or bi-directional. The selection of this variant in Representation implies that the connection speaks the Pipe protocol.

PosixSocketInfo

Defined in fuchsia.io2/posix-socket.fidl

Auxiliary data for the POSIX socket representation of a node. The selection of this variant in Representation implies that the connection speaks the fuchsia.posix.socket/Control protocol.

TtyInfo

Defined in fuchsia.io2/deprecated.fidl

The object may be cast to a Tty interface.

UNIONS

DirectoryIterator_GetNext_Result

Defined in fuchsia.io2/directory-iterator.fidl

DirectoryWatchedEvent

Defined in fuchsia.io2/directory-watcher.fidl

Events returned from DirectoryWatcher.GetNext.

Directory_Link_Result

Defined in fuchsia.io2/directory.fidl

Directory_Rename_Result

Defined in fuchsia.io2/directory.fidl

Directory_Unlink_Result

Defined in fuchsia.io2/directory.fidl

File_GetMemRange_Result

Defined in fuchsia.io2/file.fidl

File_ReadAt_Result

Defined in fuchsia.io2/file.fidl

File_Read_Result

Defined in fuchsia.io2/file.fidl

File_Resize_Result

Defined in fuchsia.io2/file.fidl

File_Seek_Result

Defined in fuchsia.io2/file.fidl

File_WriteAt_Result

Defined in fuchsia.io2/file.fidl

File_Write_Result

Defined in fuchsia.io2/file.fidl

Node_GetAttributes_Result

Defined in fuchsia.io2/node.fidl

Node_GetToken_Result

Defined in fuchsia.io2/node.fidl

Node_Sync_Result

Defined in fuchsia.io2/node.fidl

Node_UpdateAttributes_Result

Defined in fuchsia.io2/node.fidl

Representation

Defined in fuchsia.io2/connection-info.fidl

Describes how the connection should be handled, and provides auxiliary handles and information for the connection where applicable. Refer to Node.Describe and Node.OnConnectionInfo.

If handles are returned which offer alternative ways of access to the node, the rights on the handles should correspond to the rights on the connection.

If the client specified more than one protocol in protocols during Directory.Open or Node.Reopen, the Representation xunion carries additionally the result of the connection-time negotiation via its tag.

The elements have one-to-one correspondence with the members of NodeProtocols.

BITS

ConnectionFlags

Type: uint64

Defined in fuchsia.io2/connection-options.fidl

Flags applicable to both Directory.Open and Node.Reopen.

ConnectionInfoQuery

Type: uint64

Defined in fuchsia.io2/connection-info.fidl

Set the relevant bit to one to fetch the corresponding field during Node.Describe.

DeviceSignal

Type: uint32

Defined in fuchsia.io2/deprecated.fidl

DirectoryWatchMask

Type: uint64

Defined in fuchsia.io2/directory-watcher.fidl

Used by Directory.Watch to indicate the types of events interested by a watcher.

FileSignal

Type: uint32

Defined in fuchsia.io2/file.fidl

NodeAttributesQuery

Type: uint64

Defined in fuchsia.io2/node-attributes.fidl

When calling Node.GetAttributes, set the corresponding bit to one to query that particular attribute. The elements here correspond one-to-one with NodeAttributes.

NodeProtocols

Type: uint64

Defined in fuchsia.io2/connection-info.fidl

A node may have multiple supported representations when opening, even though it may have a fixed underlying identity.

Today, a file is accessed via the File protocol, and sends a Representation.FileInfo when opened with GET_CONNECTION_INFO. However, in the future we might introduce a more sophisticated FileV2 protocol, or a more efficient SuperFastFile backed by a specialized kernel object. New clients can request the more advanced representations by specifying the corresponding bits in NodeProtocols, whereas existing clients would continue to talk to the node via the old representation.

NodeProtocols enables forward-compatibility through a form of protocol negotiation.

The elements have one-to-one correspondence with the members of Representation.

Operations

Type: uint64

Defined in fuchsia.io2/rights-abilities.fidl

The common members definition behind Rights and Abilities. Note that Directory operations are distinct from File operations, with the exception of some common operations (e.g. GET_ATTRIBUTES) defined on the underlying Node.

VmoFlags

Type: uint64

Defined in fuchsia.io2/file.fidl

CONSTANTS

TYPE ALIASES