Crate fidl_next_fuchsia_io

Source

Modules§

advisory_locking
compat
Compatibility shims which mimic some API surfaces of the current Rust bindings.
directory
directory_watcher
extended_attribute_iterator
extended_attribute_value
file
linkable
node
node_info_deprecated
readable
representation
selinux_context
symlink
writable

Structs§

AdvisoryLockRange
AdvisoryLockRequest
AdvisoryLocking
The type corresponding to the AdvisoryLocking protocol. Advisory locking protocol.
AdvisoryLockingAdvisoryLockRequest
AllocateMode
ConnectionInfo
Directory
The type corresponding to the Directory protocol. Directory defines a node which is capable of containing other Objects.
DirectoryCreateSymlinkRequest
DirectoryDeprecatedOpenRequest
DirectoryGetTokenResponse
DirectoryInfo
DirectoryLinkRequest
DirectoryLinkResponse
DirectoryObject
DirectoryOpenRequest
DirectoryReadDirentsRequest
DirectoryReadDirentsResponse
DirectoryRenameRequest
DirectoryRewindResponse
DirectoryUnlinkRequest
DirectoryWatchRequest
DirectoryWatchResponse
DirectoryWatcher
The type corresponding to the DirectoryWatcher protocol. 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.
EmptyStruct
Used in places where empty structs are needed, such as empty union members, to avoid creating new struct types.
ExtendedAttributeIterator
The type corresponding to the ExtendedAttributeIterator protocol.
ExtendedAttributeIteratorGetNextResponse
File
The type corresponding to the File protocol. A Node which contains a sequence of bytes of definite length.
FileAllocateRequest
FileEnableVerityRequest
FileGetBackingMemoryRequest
FileGetBackingMemoryResponse
FileInfo
Auxiliary data for the file representation of a node.
FileObject
FileReadAtRequest
FileReadAtResponse
FileResizeRequest
FileSeekRequest
FileSeekResponse
FileSignal
FileWriteAtRequest
FileWriteAtResponse
FilesystemInfo
Flags
Flags used to specify how a node should be opened. Note that ranges of bits are reserved for specific use cases:
ImmutableNodeAttributes
Linkable
The type corresponding to the Linkable protocol.
LinkableLinkIntoRequest
ModeType
MutableNodeAttributes
Node
The type corresponding to the Node protocol. Node defines the minimal interface for entities which can be accessed in a filesystem.
NodeAttributeFlags
The fields of ‘attributes’ which are used to update the Node are indicated by the ‘flags’ argument.
NodeAttributes
NodeAttributes defines generic information about a filesystem node.
NodeAttributes2
NodeAttributesQuery
NodeDeprecatedCloneRequest
NodeDeprecatedGetFlagsResponse
NodeDeprecatedSetFlagsRequest
NodeDeprecatedSetFlagsResponse
NodeGetAttrResponse
NodeGetAttributesRequest
NodeGetExtendedAttributeRequest
NodeGetFlagsResponse
NodeInfo
Information that describes the target node.
NodeListExtendedAttributesRequest
NodeOnOpenRequest
NodeProtocolKinds
A node may have multiple supported representations when opening, even though it may have a fixed underlying identity.
NodeQueryFilesystemResponse
NodeRemoveExtendedAttributeRequest
NodeSetAttrRequest
NodeSetAttrResponse
NodeSetExtendedAttributeRequest
NodeSetFlagsRequest
OpenFlags
DEPRECATED - Use Flags instead.
Operations
The common members definition behind Rights and Abilities. Some operations may apply only to certain node types (e.g. [Operations.MODIFY_DIRECTORY] only applies to directories).
Options
Options which can be used when opening nodes. Unlike Flags, these options are designed for specific use cases (e.g. to reduce round-trip latency when requesting attributes).
Readable
The type corresponding to the Readable protocol.
ReadableReadRequest
ReadableReadResponse
Service
Symlink
The type corresponding to the Symlink protocol. A [‘Node’] which contains a symbolic link.
SymlinkInfo
SymlinkObject
UnlinkFlags
UnlinkOptions
VerificationOptions
Set of options used to enable verity on a file.
VmoFlags
WatchMask
WireAdvisoryLockRange
The wire type corresponding to AdvisoryLockRange.
WireAdvisoryLockRequest
The wire type corresponding to AdvisoryLockRequest.
WireAdvisoryLockType
The wire type corresponding to AdvisoryLockType.
WireAdvisoryLockingAdvisoryLockRequest
The wire type corresponding to AdvisoryLockingAdvisoryLockRequest.
WireAllocateMode
The wire type corresponding to AllocateMode.
WireConnectionInfo
The wire type corresponding to ConnectionInfo.
WireDirectoryCreateSymlinkRequest
The wire type corresponding to DirectoryCreateSymlinkRequest.
WireDirectoryDeprecatedOpenRequest
The wire type corresponding to DirectoryDeprecatedOpenRequest.
WireDirectoryGetTokenResponse
The wire type corresponding to DirectoryGetTokenResponse.
WireDirectoryInfo
The wire type corresponding to DirectoryInfo.
WireDirectoryLinkRequest
The wire type corresponding to DirectoryLinkRequest.
WireDirectoryLinkResponse
The wire type corresponding to DirectoryLinkResponse.
WireDirectoryObject
The wire type corresponding to DirectoryObject.
WireDirectoryOpenRequest
The wire type corresponding to DirectoryOpenRequest.
WireDirectoryReadDirentsRequest
The wire type corresponding to DirectoryReadDirentsRequest.
WireDirectoryReadDirentsResponse
The wire type corresponding to DirectoryReadDirentsResponse.
WireDirectoryRenameRequest
The wire type corresponding to DirectoryRenameRequest.
WireDirectoryRewindResponse
The wire type corresponding to DirectoryRewindResponse.
WireDirectoryUnlinkRequest
The wire type corresponding to DirectoryUnlinkRequest.
WireDirectoryWatchRequest
The wire type corresponding to DirectoryWatchRequest.
WireDirectoryWatchResponse
The wire type corresponding to DirectoryWatchResponse.
WireDirentType
The wire type corresponding to DirentType.
WireEmptyStruct
The wire type corresponding to EmptyStruct.
WireExtendedAttributeIteratorGetNextResponse
The wire type corresponding to ExtendedAttributeIteratorGetNextResponse.
WireExtendedAttributeValue
The wire type corresponding to ExtendedAttributeValue.
WireFileAllocateRequest
The wire type corresponding to FileAllocateRequest.
WireFileEnableVerityRequest
The wire type corresponding to FileEnableVerityRequest.
WireFileGetBackingMemoryRequest
The wire type corresponding to FileGetBackingMemoryRequest.
WireFileGetBackingMemoryResponse
The wire type corresponding to FileGetBackingMemoryResponse.
WireFileInfo
The wire type corresponding to FileInfo.
WireFileObject
The wire type corresponding to FileObject.
WireFileReadAtRequest
The wire type corresponding to FileReadAtRequest.
WireFileReadAtResponse
The wire type corresponding to FileReadAtResponse.
WireFileResizeRequest
The wire type corresponding to FileResizeRequest.
WireFileSeekRequest
The wire type corresponding to FileSeekRequest.
WireFileSeekResponse
The wire type corresponding to FileSeekResponse.
WireFileSignal
The wire type corresponding to FileSignal.
WireFileWriteAtRequest
The wire type corresponding to FileWriteAtRequest.
WireFileWriteAtResponse
The wire type corresponding to FileWriteAtResponse.
WireFilesystemInfo
The wire type corresponding to FilesystemInfo.
WireFlags
The wire type corresponding to Flags.
WireHashAlgorithm
The wire type corresponding to HashAlgorithm.
WireImmutableNodeAttributes
The wire type corresponding to ImmutableNodeAttributes.
WireLinkableLinkIntoRequest
The wire type corresponding to LinkableLinkIntoRequest.
WireModeType
The wire type corresponding to ModeType.
WireMutableNodeAttributes
The wire type corresponding to MutableNodeAttributes.
WireNodeAttributeFlags
The wire type corresponding to NodeAttributeFlags.
WireNodeAttributes
The wire type corresponding to NodeAttributes.
WireNodeAttributes2
The wire type corresponding to NodeAttributes2.
WireNodeAttributesQuery
The wire type corresponding to NodeAttributesQuery.
WireNodeDeprecatedCloneRequest
The wire type corresponding to NodeDeprecatedCloneRequest.
WireNodeDeprecatedGetFlagsResponse
The wire type corresponding to NodeDeprecatedGetFlagsResponse.
WireNodeDeprecatedSetFlagsRequest
The wire type corresponding to NodeDeprecatedSetFlagsRequest.
WireNodeDeprecatedSetFlagsResponse
The wire type corresponding to NodeDeprecatedSetFlagsResponse.
WireNodeGetAttrResponse
The wire type corresponding to NodeGetAttrResponse.
WireNodeGetAttributesRequest
The wire type corresponding to NodeGetAttributesRequest.
WireNodeGetExtendedAttributeRequest
The wire type corresponding to NodeGetExtendedAttributeRequest.
WireNodeGetFlagsResponse
The wire type corresponding to NodeGetFlagsResponse.
WireNodeInfo
The wire type corresponding to NodeInfo.
WireNodeInfoDeprecated
The wire type corresponding to NodeInfoDeprecated.
WireNodeListExtendedAttributesRequest
The wire type corresponding to NodeListExtendedAttributesRequest.
WireNodeOnOpenRequest
The wire type corresponding to NodeOnOpenRequest.
WireNodeProtocolKinds
The wire type corresponding to NodeProtocolKinds.
WireNodeQueryFilesystemResponse
The wire type corresponding to NodeQueryFilesystemResponse.
WireNodeRemoveExtendedAttributeRequest
The wire type corresponding to NodeRemoveExtendedAttributeRequest.
WireNodeSetAttrRequest
The wire type corresponding to NodeSetAttrRequest.
WireNodeSetAttrResponse
The wire type corresponding to NodeSetAttrResponse.
WireNodeSetExtendedAttributeRequest
The wire type corresponding to NodeSetExtendedAttributeRequest.
WireNodeSetFlagsRequest
The wire type corresponding to NodeSetFlagsRequest.
WireOpenFlags
The wire type corresponding to OpenFlags.
WireOperations
The wire type corresponding to Operations.
WireOptionalExtendedAttributeValue
WireOptionalNodeInfoDeprecated
WireOptionalRepresentation
WireOptionalSelinuxContext
WireOptions
The wire type corresponding to Options.
WireReadableReadRequest
The wire type corresponding to ReadableReadRequest.
WireReadableReadResponse
The wire type corresponding to ReadableReadResponse.
WireRepresentation
The wire type corresponding to Representation.
WireSeekOrigin
The wire type corresponding to SeekOrigin.
WireSelinuxContext
The wire type corresponding to SelinuxContext.
WireService
The wire type corresponding to Service.
WireSetExtendedAttributeMode
The wire type corresponding to SetExtendedAttributeMode.
WireSymlinkInfo
The wire type corresponding to SymlinkInfo.
WireSymlinkObject
The wire type corresponding to SymlinkObject.
WireUnlinkFlags
The wire type corresponding to UnlinkFlags.
WireUnlinkOptions
The wire type corresponding to UnlinkOptions.
WireVerificationOptions
The wire type corresponding to VerificationOptions.
WireVmoFlags
The wire type corresponding to VmoFlags.
WireWatchEvent
The wire type corresponding to WatchEvent.
WireWatchMask
The wire type corresponding to WatchMask.
WireWritableWriteRequest
The wire type corresponding to WritableWriteRequest.
WireWritableWriteResponse
The wire type corresponding to WritableWriteResponse.
Writable
The type corresponding to the Writable protocol.
WritableWriteRequest
WritableWriteResponse

Enums§

AdvisoryLockType
DirentType
ExtendedAttributeValue
The value type for an extended attribute. If the value is less than 32768 bytes, then it is included inline. Values larger than this size are written into a vmo buffer.
HashAlgorithm
Denotes which hash algorithm is used to build the merkle tree for fsverity-enabled files.
NodeInfoDeprecated
Representation
SeekOrigin
The reference point for updating the seek offset. See [File.Seek].
SelinuxContext
SetExtendedAttributeMode
WatchEvent

Constants§

DIRECTORY_PROTOCOL_NAME
FILE_PROTOCOL_NAME
FLAG_TEMPORARY_AS_NOT_LINKABLE
Specifies that this object is not linkable. This is only intended to be used in the context of creating a temporary unnamed objects. When that is not the case, the node protocol defines if it is linkable (i.e. if it composes the Linkable protocol). When this flag is set along with Flags.FLAG_CREATE_AS_UNNAMED_TEMPORARY, an unnamed temporary object will be created that cannot be linked into the filesystem. This would be similar to Linux O_TMPFILE | O_EXCL.
INHERITED_WRITE_PERMISSIONS
Set of rights that [Flags.PERM_INHERIT_WRITE] will inherit from the parent connection if specified. Note that if any of these permissions are missing from the connection, none of these permissions will be inherited.
INO_UNKNOWN
Nodes which do not have ino values should return this value from Readdir and GetAttr.
MASK_KNOWN_PERMISSIONS
MASK_KNOWN_PROTOCOLS
MASK_PERMISSION_FLAGS
MASK_POSIX_FLAGS
MAX_ATTRIBUTE_NAME
The maximum size for an extended attribute name.
MAX_BUF
The maximal buffer size which can be transmitted for buffered operations. This capacity is currently set somewhat arbitrarily.
MAX_FILENAME
The maximum length, in bytes, of a single filesystem component.
MAX_FS_NAME_BUFFER
MAX_INLINE_ATTRIBUTE_VALUE
The maximum size for an extended attribute value to be included inline. Values larger than this size are passed in a vmo.
MAX_LIST_ATTRIBUTES_CHUNK
The maximum size of a chunk in the ListExtendedAttributes iterator.
MAX_NAME_LENGTH
The maximum length, in bytes, of a single filesystem component.
MAX_PATH_LENGTH
The maximum length, in bytes, of a filesystem path.
MAX_SELINUX_CONTEXT_ATTRIBUTE_LEN
The maximum size for passing the SELinux context as an attribute.
MAX_TRANSFER_SIZE
The maximum I/O size that is allowed for read/write operations using byte vectors.
MODE_PROTECTION_MASK
Bits reserved for posix protections. Native fuchsia filesystems are not required to set bits contained within MODE_PROTECTION_MASK, but filesystems that wish to do so may refer to sys/stat.h for their definitions.
MODE_TYPE_BLOCK_DEVICE
MODE_TYPE_DIRECTORY
MODE_TYPE_FILE
MODE_TYPE_MASK
Bits indicating node type. The canonical mechanism to check for a node type is to take ‘mode’, bitwise AND it with the MODE_TYPE_MASK, and check exact equality against a mode type.
MODE_TYPE_SERVICE
MODE_TYPE_SYMLINK
NODE_PROTOCOL_NAME
OPEN_FLAGS_ALLOWED_WITH_NODE_REFERENCE
Flags used when opening a node reference must fall within this mask.
OPEN_RIGHTS
All known rights.
PERM_EXECUTABLE
Set of permissions that are expected when opening a node as executable.
PERM_READABLE
Set of permissions that are expected when opening a node as readable.
PERM_WRITABLE
Set of permissions that are expected when opening a node as writable.
RW_STAR_DIR
Alias for directory permission alias rw*
RX_STAR_DIR
Alias for directory permission alias rx*
R_STAR_DIR
Alias for directory permission alias r*
SELINUX_CONTEXT_NAME
The name of the extended attribute accessible via the SELinux context attribute.
SYMLINK_PROTOCOL_NAME
W_STAR_DIR
Alias for directory permission alias w*
X_STAR_DIR
Alias for directory permission alias x*

Traits§

AdvisoryLockingClientHandler
A client handler for the AdvisoryLocking protocol.
AdvisoryLockingClientSender
A helper trait for the AdvisoryLocking client sender.
AdvisoryLockingServerHandler
A server handler for the AdvisoryLocking protocol.
AdvisoryLockingServerSender
A helper trait for the AdvisoryLocking server sender.
DirectoryClientHandler
A client handler for the Directory protocol.
DirectoryClientSender
A helper trait for the Directory client sender.
DirectoryServerHandler
A server handler for the Directory protocol.
DirectoryServerSender
A helper trait for the Directory server sender.
DirectoryWatcherClientHandler
A client handler for the DirectoryWatcher protocol.
DirectoryWatcherClientSender
A helper trait for the DirectoryWatcher client sender.
DirectoryWatcherServerHandler
A server handler for the DirectoryWatcher protocol.
DirectoryWatcherServerSender
A helper trait for the DirectoryWatcher server sender.
ExtendedAttributeIteratorClientHandler
A client handler for the ExtendedAttributeIterator protocol.
ExtendedAttributeIteratorClientSender
A helper trait for the ExtendedAttributeIterator client sender.
ExtendedAttributeIteratorServerHandler
A server handler for the ExtendedAttributeIterator protocol.
ExtendedAttributeIteratorServerSender
A helper trait for the ExtendedAttributeIterator server sender.
FileClientHandler
A client handler for the File protocol.
FileClientSender
A helper trait for the File client sender.
FileServerHandler
A server handler for the File protocol.
FileServerSender
A helper trait for the File server sender.
LinkableClientHandler
A client handler for the Linkable protocol.
LinkableClientSender
A helper trait for the Linkable client sender.
LinkableServerHandler
A server handler for the Linkable protocol.
LinkableServerSender
A helper trait for the Linkable server sender.
NodeClientHandler
A client handler for the Node protocol.
NodeClientSender
A helper trait for the Node client sender.
NodeServerHandler
A server handler for the Node protocol.
NodeServerSender
A helper trait for the Node server sender.
ReadableClientHandler
A client handler for the Readable protocol.
ReadableClientSender
A helper trait for the Readable client sender.
ReadableServerHandler
A server handler for the Readable protocol.
ReadableServerSender
A helper trait for the Readable server sender.
SymlinkClientHandler
A client handler for the Symlink protocol.
SymlinkClientSender
A helper trait for the Symlink client sender.
SymlinkServerHandler
A server handler for the Symlink protocol.
SymlinkServerSender
A helper trait for the Symlink server sender.
WritableClientHandler
A client handler for the Writable protocol.
WritableClientSender
A helper trait for the Writable client sender.
WritableServerHandler
A server handler for the Writable protocol.
WritableServerSender
A helper trait for the Writable server sender.

Type Aliases§

Abilities
Abilities are properties intrinsic to a node. They specify which operations are supported by it.
AdvisoryLockingAdvisoryLockResponse
DirectoryCreateSymlinkResponse
DirectoryRenameResponse
DirectoryUnlinkResponse
ExtendedAttributeName
The name of an extended attribute. It can not contain any null bytes. Other than that and the maximum size, no particular structure is imposed on the name.
FileAllocateResponse
FileEnableVerityResponse
FileResizeResponse
Id
The type to identify a node, if the implementation supports some notion of unique node ID.
LinkableLinkIntoResponse
Name
The type for the name of a node, i.e. a single path component. E.g. foo
NodeRemoveExtendedAttributeResponse
NodeSetExtendedAttributeResponse
NodeSetFlagsResponse
NodeSyncResponse
NodeUpdateAttributesResponse
Path
A path is a string of one or more components, separated by “/”. E.g. foo/bar/baz
Rights
Rights are properties specific to a connection. They limit which operations are allowed on a connection, including those which may be granted to new connections.
SymlinkTarget
Token
The type to identify a connection to a node. It represents a capability: a reference to a node with associated rights.
Transfer
The byte vector type used for read/write operations.
WireAbilities
The wire type corresponding to Abilities.
WireAdvisoryLockingAdvisoryLockResponse
The wire type corresponding to AdvisoryLockingAdvisoryLockResponse.
WireDirectoryCreateSymlinkResponse
The wire type corresponding to DirectoryCreateSymlinkResponse.
WireDirectoryRenameResponse
The wire type corresponding to DirectoryRenameResponse.
WireDirectoryUnlinkResponse
The wire type corresponding to DirectoryUnlinkResponse.
WireExtendedAttributeName
The wire type corresponding to ExtendedAttributeName.
WireFileAllocateResponse
The wire type corresponding to FileAllocateResponse.
WireFileEnableVerityResponse
The wire type corresponding to FileEnableVerityResponse.
WireFileResizeResponse
The wire type corresponding to FileResizeResponse.
WireId
The wire type corresponding to Id.
WireLinkableLinkIntoResponse
The wire type corresponding to LinkableLinkIntoResponse.
WireName
The wire type corresponding to Name.
WireNodeRemoveExtendedAttributeResponse
The wire type corresponding to NodeRemoveExtendedAttributeResponse.
WireNodeSetExtendedAttributeResponse
The wire type corresponding to NodeSetExtendedAttributeResponse.
WireNodeSetFlagsResponse
The wire type corresponding to NodeSetFlagsResponse.
WireNodeSyncResponse
The wire type corresponding to NodeSyncResponse.
WireNodeUpdateAttributesResponse
The wire type corresponding to NodeUpdateAttributesResponse.
WirePath
The wire type corresponding to Path.
WireRights
The wire type corresponding to Rights.
WireSymlinkTarget
The wire type corresponding to SymlinkTarget.
WireToken
The wire type corresponding to Token.
WireTransfer
The wire type corresponding to Transfer.