Struct fidl_fuchsia_io::FileProxy
source · pub struct FileProxy { /* private fields */ }
Implementations§
source§impl FileProxy
impl FileProxy
sourcepub fn take_event_stream(&self) -> FileEventStream
pub fn take_event_stream(&self) -> FileEventStream
Get a Stream of events from the remote end of the protocol.
§Panics
Panics if the event stream was already taken.
sourcepub fn advisory_lock(
&self,
request: &AdvisoryLockRequest,
) -> QueryResponseFut<AdvisoryLockingAdvisoryLockResult>
pub fn advisory_lock( &self, request: &AdvisoryLockRequest, ) -> QueryResponseFut<AdvisoryLockingAdvisoryLockResult>
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
] ifrequest.type
is [AdvisoryLockType.READ
]. - [
Rights.WRITE_BYTES
] ifrequest.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.
sourcepub fn link_into(
&self,
dst_parent_token: Event,
dst: &str,
) -> QueryResponseFut<LinkableLinkIntoResult>
pub fn link_into( &self, dst_parent_token: Event, dst: &str, ) -> QueryResponseFut<LinkableLinkIntoResult>
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.
sourcepub fn clone(
&self,
flags: OpenFlags,
object: ServerEnd<NodeMarker>,
) -> Result<(), Error>
pub fn clone( &self, flags: OpenFlags, object: ServerEnd<NodeMarker>, ) -> Result<(), Error>
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
.
sourcepub fn get_attr(&self) -> QueryResponseFut<(i32, NodeAttributes)>
pub fn get_attr(&self) -> QueryResponseFut<(i32, NodeAttributes)>
Acquires information about the node.
This method does not require any rights.
sourcepub fn set_attr(
&self,
flags: NodeAttributeFlags,
attributes: &NodeAttributes,
) -> QueryResponseFut<i32>
pub fn set_attr( &self, flags: NodeAttributeFlags, attributes: &NodeAttributes, ) -> QueryResponseFut<i32>
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
.
sourcepub fn get_flags(&self) -> QueryResponseFut<(i32, OpenFlags)>
pub fn get_flags(&self) -> QueryResponseFut<(i32, OpenFlags)>
Acquires the Directory.Open
rights and flags used to access this file.
This method does not require any rights.
sourcepub fn set_flags(&self, flags: OpenFlags) -> QueryResponseFut<i32>
pub fn set_flags(&self, flags: OpenFlags) -> QueryResponseFut<i32>
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.
sourcepub fn query_filesystem(
&self,
) -> QueryResponseFut<(i32, Option<Box<FilesystemInfo>>)>
pub fn query_filesystem( &self, ) -> QueryResponseFut<(i32, Option<Box<FilesystemInfo>>)>
Query the filesystem for filesystem-specific information.
sourcepub fn close(&self) -> QueryResponseFut<CloseableCloseResult>
pub fn close(&self) -> QueryResponseFut<CloseableCloseResult>
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.
pub fn query(&self) -> QueryResponseFut<Vec<u8>>
sourcepub fn reopen(
&self,
rights_request: &RightsRequest,
object_request: ServerEnd<NodeMarker>,
) -> Result<(), Error>
pub fn reopen( &self, rights_request: &RightsRequest, object_request: ServerEnd<NodeMarker>, ) -> Result<(), Error>
Creates another connection to the same node.
sourcepub fn get_connection_info(&self) -> QueryResponseFut<ConnectionInfo>
pub fn get_connection_info(&self) -> QueryResponseFut<ConnectionInfo>
Acquires information about the connection.
This method does not require any rights.
sourcepub fn get_attributes(
&self,
query: NodeAttributesQuery,
) -> QueryResponseFut<Node2GetAttributesResult>
pub fn get_attributes( &self, query: NodeAttributesQuery, ) -> QueryResponseFut<Node2GetAttributesResult>
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.
sourcepub fn update_attributes(
&self,
payload: &MutableNodeAttributes,
) -> QueryResponseFut<Node2UpdateAttributesResult>
pub fn update_attributes( &self, payload: &MutableNodeAttributes, ) -> QueryResponseFut<Node2UpdateAttributesResult>
Updates information about the node.
attributes
the presence of a table field inattributes
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.
sourcepub fn sync(&self) -> QueryResponseFut<Node2SyncResult>
pub fn sync(&self) -> QueryResponseFut<Node2SyncResult>
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.
sourcepub fn list_extended_attributes(
&self,
iterator: ServerEnd<ExtendedAttributeIteratorMarker>,
) -> Result<(), Error>
pub fn list_extended_attributes( &self, iterator: ServerEnd<ExtendedAttributeIteratorMarker>, ) -> Result<(), Error>
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.
sourcepub fn get_extended_attribute(
&self,
name: &[u8],
) -> QueryResponseFut<Node2GetExtendedAttributeResult>
pub fn get_extended_attribute( &self, name: &[u8], ) -> QueryResponseFut<Node2GetExtendedAttributeResult>
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.
sourcepub fn set_extended_attribute(
&self,
name: &[u8],
value: ExtendedAttributeValue,
mode: SetExtendedAttributeMode,
) -> QueryResponseFut<Node2SetExtendedAttributeResult>
pub fn set_extended_attribute( &self, name: &[u8], value: ExtendedAttributeValue, mode: SetExtendedAttributeMode, ) -> QueryResponseFut<Node2SetExtendedAttributeResult>
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.
sourcepub fn remove_extended_attribute(
&self,
name: &[u8],
) -> QueryResponseFut<Node2RemoveExtendedAttributeResult>
pub fn remove_extended_attribute( &self, name: &[u8], ) -> QueryResponseFut<Node2RemoveExtendedAttributeResult>
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.
sourcepub fn read(&self, count: u64) -> QueryResponseFut<ReadableReadResult>
pub fn read(&self, count: u64) -> QueryResponseFut<ReadableReadResult>
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 thancount
. - If
data.length
is less thancount
, it means that the seek offset has reached the end of file as part of this operation. - If
data.length
is zero whilecount
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 emptydata
vector.
This method requires the [Rights.READ_BYTES
] right.
Returns ZX_ERR_OUT_OF_RANGE
if count
is greater than MAX_TRANSFER_SIZE
.
sourcepub fn write(&self, data: &[u8]) -> QueryResponseFut<WritableWriteResult>
pub fn write(&self, data: &[u8]) -> QueryResponseFut<WritableWriteResult>
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 thandata.length
. - If the server is unable to write all the data due to e.g. not enough
space,
actual_count
may be less thandata.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.
pub fn describe(&self) -> QueryResponseFut<FileInfo>
sourcepub fn seek(
&self,
origin: SeekOrigin,
offset: i64,
) -> QueryResponseFut<FileSeekResult>
pub fn seek( &self, origin: SeekOrigin, offset: i64, ) -> QueryResponseFut<FileSeekResult>
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 whereoffset
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.
sourcepub fn read_at(
&self,
count: u64,
offset: u64,
) -> QueryResponseFut<FileReadAtResult>
pub fn read_at( &self, count: u64, offset: u64, ) -> QueryResponseFut<FileReadAtResult>
Reads up to ‘count’ bytes at the provided offset. Does not affect the seek offset.
§Invariants
- The returned
data.length
will never be greater thancount
. - If
data.length
is less thancount
, it means thatReadAt
has hit the end of file as part of this operation. - If
data.length
is zero whilecount
is not, it means thatoffset
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 emptydata
vector.
This method requires the [Rights.READ_BYTES
] right.
Returns ZX_ERR_OUT_OF_RANGE
if count
is greater than MAX_TRANSFER_SIZE
.
sourcepub fn write_at(
&self,
data: &[u8],
offset: u64,
) -> QueryResponseFut<FileWriteAtResult>
pub fn write_at( &self, data: &[u8], offset: u64, ) -> QueryResponseFut<FileWriteAtResult>
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 thandata.length
. - If the server is unable to write all the data due to e.g. not enough
space,
actual_count
may be less thandata.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.
sourcepub fn resize(&self, length: u64) -> QueryResponseFut<FileResizeResult>
pub fn resize(&self, length: u64) -> QueryResponseFut<FileResizeResult>
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.
sourcepub fn get_backing_memory(
&self,
flags: VmoFlags,
) -> QueryResponseFut<FileGetBackingMemoryResult>
pub fn get_backing_memory( &self, flags: VmoFlags, ) -> QueryResponseFut<FileGetBackingMemoryResult>
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
aVmoFlags
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
] ifflags
includes [VmoFlags.READ
]. - [
Rights.WRITE_BYTES
] ifflags
includes [VmoFlags.WRITE
]. - [
Rights.EXECUTE
] ifflags
includes [VmoFlags.EXECUTE
].
sourcepub fn allocate(
&self,
offset: u64,
length: u64,
mode: AllocateMode,
) -> QueryResponseFut<FileAllocateResult>
pub fn allocate( &self, offset: u64, length: u64, mode: AllocateMode, ) -> QueryResponseFut<FileAllocateResult>
Pre-allocate on-disk space for this file.
sourcepub fn enable_verity(
&self,
options: &VerificationOptions,
) -> QueryResponseFut<FileEnableVerityResult>
pub fn enable_verity( &self, options: &VerificationOptions, ) -> QueryResponseFut<FileEnableVerityResult>
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
.
Trait Implementations§
source§impl FileProxyInterface for FileProxy
impl FileProxyInterface for FileProxy
type AdvisoryLockResponseFut = QueryResponseFut<Result<(), i32>>
fn advisory_lock( &self, request: &AdvisoryLockRequest, ) -> Self::AdvisoryLockResponseFut
type LinkIntoResponseFut = QueryResponseFut<Result<(), i32>>
fn link_into( &self, dst_parent_token: Event, dst: &str, ) -> Self::LinkIntoResponseFut
fn clone( &self, flags: OpenFlags, object: ServerEnd<NodeMarker>, ) -> Result<(), Error>
type GetAttrResponseFut = QueryResponseFut<(i32, NodeAttributes)>
fn get_attr(&self) -> Self::GetAttrResponseFut
type SetAttrResponseFut = QueryResponseFut<i32>
fn set_attr( &self, flags: NodeAttributeFlags, attributes: &NodeAttributes, ) -> Self::SetAttrResponseFut
type GetFlagsResponseFut = QueryResponseFut<(i32, OpenFlags)>
fn get_flags(&self) -> Self::GetFlagsResponseFut
type SetFlagsResponseFut = QueryResponseFut<i32>
fn set_flags(&self, flags: OpenFlags) -> Self::SetFlagsResponseFut
type QueryFilesystemResponseFut = QueryResponseFut<(i32, Option<Box<FilesystemInfo>>)>
fn query_filesystem(&self) -> Self::QueryFilesystemResponseFut
type CloseResponseFut = QueryResponseFut<Result<(), i32>>
fn close(&self) -> Self::CloseResponseFut
type QueryResponseFut = QueryResponseFut<Vec<u8>>
fn query(&self) -> Self::QueryResponseFut
fn reopen( &self, rights_request: &RightsRequest, object_request: ServerEnd<NodeMarker>, ) -> Result<(), Error>
type GetConnectionInfoResponseFut = QueryResponseFut<ConnectionInfo>
fn get_connection_info(&self) -> Self::GetConnectionInfoResponseFut
type GetAttributesResponseFut = QueryResponseFut<Result<(MutableNodeAttributes, ImmutableNodeAttributes), i32>>
fn get_attributes( &self, query: NodeAttributesQuery, ) -> Self::GetAttributesResponseFut
type UpdateAttributesResponseFut = QueryResponseFut<Result<(), i32>>
fn update_attributes( &self, payload: &MutableNodeAttributes, ) -> Self::UpdateAttributesResponseFut
type SyncResponseFut = QueryResponseFut<Result<(), i32>>
fn sync(&self) -> Self::SyncResponseFut
fn list_extended_attributes( &self, iterator: ServerEnd<ExtendedAttributeIteratorMarker>, ) -> Result<(), Error>
type GetExtendedAttributeResponseFut = QueryResponseFut<Result<ExtendedAttributeValue, i32>>
fn get_extended_attribute( &self, name: &[u8], ) -> Self::GetExtendedAttributeResponseFut
type SetExtendedAttributeResponseFut = QueryResponseFut<Result<(), i32>>
fn set_extended_attribute( &self, name: &[u8], value: ExtendedAttributeValue, mode: SetExtendedAttributeMode, ) -> Self::SetExtendedAttributeResponseFut
type RemoveExtendedAttributeResponseFut = QueryResponseFut<Result<(), i32>>
fn remove_extended_attribute( &self, name: &[u8], ) -> Self::RemoveExtendedAttributeResponseFut
type ReadResponseFut = QueryResponseFut<Result<Vec<u8>, i32>>
fn read(&self, count: u64) -> Self::ReadResponseFut
type WriteResponseFut = QueryResponseFut<Result<u64, i32>>
fn write(&self, data: &[u8]) -> Self::WriteResponseFut
type DescribeResponseFut = QueryResponseFut<FileInfo>
fn describe(&self) -> Self::DescribeResponseFut
type SeekResponseFut = QueryResponseFut<Result<u64, i32>>
fn seek(&self, origin: SeekOrigin, offset: i64) -> Self::SeekResponseFut
type ReadAtResponseFut = QueryResponseFut<Result<Vec<u8>, i32>>
fn read_at(&self, count: u64, offset: u64) -> Self::ReadAtResponseFut
type WriteAtResponseFut = QueryResponseFut<Result<u64, i32>>
fn write_at(&self, data: &[u8], offset: u64) -> Self::WriteAtResponseFut
type ResizeResponseFut = QueryResponseFut<Result<(), i32>>
fn resize(&self, length: u64) -> Self::ResizeResponseFut
type GetBackingMemoryResponseFut = QueryResponseFut<Result<Vmo, i32>>
fn get_backing_memory( &self, flags: VmoFlags, ) -> Self::GetBackingMemoryResponseFut
type AllocateResponseFut = QueryResponseFut<Result<(), i32>>
fn allocate( &self, offset: u64, length: u64, mode: AllocateMode, ) -> Self::AllocateResponseFut
type EnableVerityResponseFut = QueryResponseFut<Result<(), i32>>
fn enable_verity( &self, options: &VerificationOptions, ) -> Self::EnableVerityResponseFut
source§impl Proxy for FileProxy
impl Proxy for FileProxy
§type Protocol = FileMarker
type Protocol = FileMarker
Proxy
controls.source§fn from_channel(inner: AsyncChannel) -> Self
fn from_channel(inner: AsyncChannel) -> Self
source§fn into_channel(self) -> Result<AsyncChannel, Self>
fn into_channel(self) -> Result<AsyncChannel, Self>
source§fn as_channel(&self) -> &AsyncChannel
fn as_channel(&self) -> &AsyncChannel
§fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>
fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>
Auto Trait Implementations§
impl Freeze for FileProxy
impl !RefUnwindSafe for FileProxy
impl Send for FileProxy
impl Sync for FileProxy
impl Unpin for FileProxy
impl !UnwindSafe for FileProxy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)