Enum FileRequest

pub enum FileRequest {
    AdvisoryLock {
        request: AdvisoryLockRequest,
        responder: FileAdvisoryLockResponder,
    },
    LinkInto {
        dst_parent_token: Event,
        dst: String,
        responder: FileLinkIntoResponder,
    },
    Clone {
        request: ServerEnd<CloneableMarker>,
        control_handle: FileControlHandle,
    },
    Close {
        responder: FileCloseResponder,
    },
    Query {
        responder: FileQueryResponder,
    },
    DeprecatedClone {
        flags: OpenFlags,
        object: ServerEnd<NodeMarker>,
        control_handle: FileControlHandle,
    },
    GetAttr {
        responder: FileGetAttrResponder,
    },
    SetAttr {
        flags: NodeAttributeFlags,
        attributes: NodeAttributes,
        responder: FileSetAttrResponder,
    },
    GetFlags {
        responder: FileGetFlagsResponder,
    },
    SetFlags {
        flags: OpenFlags,
        responder: FileSetFlagsResponder,
    },
    GetFlags2 {
        responder: FileGetFlags2Responder,
    },
    SetFlags2 {
        flags: Flags,
        responder: FileSetFlags2Responder,
    },
    QueryFilesystem {
        responder: FileQueryFilesystemResponder,
    },
    GetConnectionInfo {
        responder: FileGetConnectionInfoResponder,
    },
    GetAttributes {
        query: NodeAttributesQuery,
        responder: FileGetAttributesResponder,
    },
    UpdateAttributes {
        payload: MutableNodeAttributes,
        responder: FileUpdateAttributesResponder,
    },
    Sync {
        responder: FileSyncResponder,
    },
    ListExtendedAttributes {
        iterator: ServerEnd<ExtendedAttributeIteratorMarker>,
        control_handle: FileControlHandle,
    },
    GetExtendedAttribute {
        name: Vec<u8>,
        responder: FileGetExtendedAttributeResponder,
    },
    SetExtendedAttribute {
        name: Vec<u8>,
        value: ExtendedAttributeValue,
        mode: SetExtendedAttributeMode,
        responder: FileSetExtendedAttributeResponder,
    },
    RemoveExtendedAttribute {
        name: Vec<u8>,
        responder: FileRemoveExtendedAttributeResponder,
    },
    Read {
        count: u64,
        responder: FileReadResponder,
    },
    Write {
        data: Vec<u8>,
        responder: FileWriteResponder,
    },
    Describe {
        responder: FileDescribeResponder,
    },
    Seek {
        origin: SeekOrigin,
        offset: i64,
        responder: FileSeekResponder,
    },
    ReadAt {
        count: u64,
        offset: u64,
        responder: FileReadAtResponder,
    },
    WriteAt {
        data: Vec<u8>,
        offset: u64,
        responder: FileWriteAtResponder,
    },
    Resize {
        length: u64,
        responder: FileResizeResponder,
    },
    GetBackingMemory {
        flags: VmoFlags,
        responder: FileGetBackingMemoryResponder,
    },
    Allocate {
        offset: u64,
        length: u64,
        mode: AllocateMode,
        responder: FileAllocateResponder,
    },
    EnableVerity {
        options: VerificationOptions,
        responder: FileEnableVerityResponder,
    },
    _UnknownMethod {
        ordinal: u64,
        control_handle: FileControlHandle,
        method_type: MethodType,
    },
}

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

NOTE: cloned connections do not share their seek offset with their source connection.

Variants

AdvisoryLock

Acquires an advisory lock on the underlying file.

The lock lasts until either this connection is closed or this method is called with |AdvisoryLockType.UNLOCK| to release the lock explicitly.

Advisory locks are purely advisory. They do not prevent actual read or write operations from occurring on the file, either through this connection or through other connections.

This method requires the following rights:

• [Rights.READ_BYTES] if request.type is [AdvisoryLockType.READ].
• [Rights.WRITE_BYTES] if request.type is [AdvisoryLockType.WRITE].

Errors

• ZX_ERR_BAD_STATE The specified type of lock cannot be acquired. For example, another connection might hold a conflicting lock type.
• ZX_ERR_NOT_SUPPORTED This file does not support advisory locking.
• ZX_ERR_ACCESS_DENIED This connection does not have sufficient rights to acquire the given type of lock.

Fields

request: AdvisoryLockRequest

responder: FileAdvisoryLockResponder

LinkInto

Creates a link to this this object with name dst in the directory represented by dst_parent_token.

dst must be a resolved object name. Including “/” in the string will return ZX_ERR_INVALID_ARGS.

This method requires the maximal set of rights supported by the filesystem for this object. For files this would typically be [Rights.READ_BYTES], [Rights.WRITE_BYTES], [Rights.GET_ATTRIBUTES] and [Rights.UPDATE_ATTRIBUTES]. Some filesystems might also support the [Rights.EXECUTE] right. Insufficient rights will result in ZX_ERR_ACCESS_DENIED.

If this object has no links, it will fail with ZX_ERR_NOT_FOUND.

This method does not have the same atomicity properties has the Directory::Link method, which means that calling Open then LinkInto is not equivalent to Directory::Link because LinkInto will not prevent the source from being renamed or unlinked.

Fields

dst_parent_token: Event

dst: String

responder: FileLinkIntoResponder

Clone

Fields

request: ServerEnd<CloneableMarker>

control_handle: FileControlHandle

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

Query

Fields

responder: FileQueryResponder

DeprecatedClone

Fields

flags: OpenFlags

object: ServerEnd<NodeMarker>

control_handle: FileControlHandle

GetAttr

Acquires information about the node.

This method does not require any rights.

Fields

responder: FileGetAttrResponder

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

GetFlags

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

This method does not require any rights.

Fields

responder: FileGetFlagsResponder

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

GetFlags2

Queries the flags that apply to this node after it has been opened/created. This method does not require any rights.

Note that the final set of flags that apply to the connection may differ from those specified with the fuchsia.io/Directory.Open request used to create it:

• Flags.PERM_INHERIT_*: Only applies when determining connection rights.
• Flags.PROTOCOL_*: Only the protocol of the connection will be present.
• Flags.FLAG_*: Only applies when opening the resource, not part of the connection.

Fields

responder: FileGetFlags2Responder

SetFlags2

Sets the flags that apply to this node after it has been opened. This method does not require any rights.

Only Flags.FILE_APPEND is currently supported. Calling this method without any flags will clear append mode.

Errors:

• ZX_ERR_NOT_SUPPORTED: The object does not support this feature or the specified flags.
• ZX_ERR_INVALID_ARGS: flags other than Flags.FILE_APPEND were specified.

Fields

flags: Flags

responder: FileSetFlags2Responder

QueryFilesystem

Query the filesystem for filesystem-specific information.

Fields

responder: FileQueryFilesystemResponder

GetConnectionInfo

Acquires information about the connection.

This method does not require any rights.

Fields

responder: FileGetConnectionInfoResponder

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

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

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

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

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

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

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

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.

Returns ZX_ERR_OUT_OF_RANGE if count is greater than MAX_TRANSFER_SIZE.

Fields

count: u64

responder: FileReadResponder

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 no bytes could be written, an error is returned.
• If data.length is zero, the server should perform all the checks ensuring write access without mutating the file and return a successful write of zero bytes. The seek offset is still updated if in append mode.

This method requires the [Rights.WRITE_BYTES] right.

Fields

data: Vec<u8>

responder: FileWriteResponder

Describe

Fields

responder: FileDescribeResponder

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.

Fields

origin: SeekOrigin

offset: i64

responder: FileSeekResponder

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.

Returns ZX_ERR_OUT_OF_RANGE if count is greater than MAX_TRANSFER_SIZE.

Fields

count: u64

offset: u64

responder: FileReadAtResponder

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 no bytes could be written, an error is returned.
• If data.length is zero, the server should perform all the checks ensuring write access without mutating the file, and will return a successful write of zero bytes.

This method requires the [Rights.WRITE_BYTES] right.

Fields

data: Vec<u8>

offset: u64

responder: FileWriteAtResponder

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.

Fields

length: u64

responder: FileResizeResponder

GetBackingMemory

Acquires a [zx.Handle:VMO] representing this file, if there is one, with the requested access rights.

Implementations are not required to implement files backed by VMOs so this request may fail. Additionally, implementations may only support a certain subset of the flags. Clients should be prepared with fallback behavior if this request fails.

If a client specifies neither PRIVATE_CLONE nor SHARED_BUFFER, the implementation is free to choose the semantics of the returned VMO.

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

• response vmo the requested [zx.Handle:VMO].

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

Fields

flags: VmoFlags

responder: FileGetBackingMemoryResponder

Allocate

Pre-allocate on-disk space for this file.

Fields

offset: u64

length: u64

mode: AllocateMode

responder: FileAllocateResponder

EnableVerity

Enables verification for the file (permanently) which involves computing a merkle tree for the file. Forces a flush prior to building the merkle tree to ensure cached data is captured. Future reads will be verified against the computed merkle tree and writes will be rejected. This method can take some time to complete as it depends on the size of the file. This method can be aborted by closing the connection that this method was issued on.

This method requires the [Rights.UPDATE_ATTRIBUTES] right. Returns ZX_ERR_NOT_SUPPORTED if the filesystem does not support verity. Returns ZX_ERR_ALREADY_EXISTS if the file was already fsverity-enabled. Also returns any error that might arise from reading the file, or from flushing the file, such as ZX_ERR_IO.

Fields

options: VerificationOptions

responder: FileEnableVerityResponder

_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: FileControlHandle

method_type: MethodType

Implementations

impl FileRequest

pub fn into_advisory_lock( self, ) -> Option<(AdvisoryLockRequest, FileAdvisoryLockResponder)>

pub fn into_link_into(self) -> Option<(Event, String, FileLinkIntoResponder)>

pub fn into_clone( self, ) -> Option<(ServerEnd<CloneableMarker>, FileControlHandle)>

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

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

pub fn into_deprecated_clone( self, ) -> Option<(OpenFlags, ServerEnd<NodeMarker>, FileControlHandle)>

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

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

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

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

pub fn into_get_flags2(self) -> Option<FileGetFlags2Responder>

pub fn into_set_flags2(self) -> Option<(Flags, FileSetFlags2Responder)>

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

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

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

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

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

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

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

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

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

pub fn into_read(self) -> Option<(u64, FileReadResponder)>

pub fn into_write(self) -> Option<(Vec<u8>, FileWriteResponder)>

pub fn into_describe(self) -> Option<FileDescribeResponder>

pub fn into_seek(self) -> Option<(SeekOrigin, i64, FileSeekResponder)>

pub fn into_read_at(self) -> Option<(u64, u64, FileReadAtResponder)>

pub fn into_write_at(self) -> Option<(Vec<u8>, u64, FileWriteAtResponder)>

pub fn into_resize(self) -> Option<(u64, FileResizeResponder)>

pub fn into_get_backing_memory( self, ) -> Option<(VmoFlags, FileGetBackingMemoryResponder)>

pub fn into_allocate( self, ) -> Option<(u64, u64, AllocateMode, FileAllocateResponder)>

pub fn into_enable_verity( self, ) -> Option<(VerificationOptions, FileEnableVerityResponder)>

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

Name of the method defined in FIDL

Trait Implementations

impl Debug for FileRequest

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

Formats the value using the given formatter.