Struct RemoteIo 

pub struct RemoteIo { /* private fields */ }

Wraps a proxy and optional stream and provides wrappers around most fuchsia.io methods.

NOTE: The caller must take care to call appropriate methods for the underlying type. Calling the wrong methods (e.g. calling file methods on a directory) will result in the connection being closed.

Implementations

impl RemoteIo

pub fn new(proxy: NodeSynchronousProxy) -> Self

pub fn with_stream(proxy: NodeSynchronousProxy, stream: Stream) -> Self

pub fn into_proxy(self) -> NodeSynchronousProxy

pub fn attr_get( &self, query: NodeAttributesQuery, ) -> Result<(MutableNodeAttributes, ImmutableNodeAttributes), Status>

Returns attributes in fuchsia.io’s FIDL representation.

pub fn attr_get_zxio( &self, query: NodeAttributesQuery, ) -> Result<zxio_node_attributes_t, Status>

Returns attributes mapped to zxio_node_attributes_t

NOTE: Not all attributes are supported. See zxio_attr_from_fidl above for supported attributes.

pub fn attr_set(&self, attributes: MutableNodeAttributes) -> Result<(), Status>

Sets attributes.

pub fn open<F: Factory>( &self, path: &str, flags: Flags, create_attributes: Option<MutableNodeAttributes>, query: NodeAttributesQuery, factory: F, ) -> Result<(F::Result, zxio_node_attributes_t, Option<SelinuxContext>), Status>

Wraps fuchsia.io/Directory’s Open.

pub fn read_partial( &self, offset: u64, max: usize, ) -> Result<(Vec<u8>, bool), Status>

Returns (data, eof), where eof is true if we encountered the end of the file. If eof is false, then it is still possible that a subsequent read would read no more i.e. the end of the file might have been reached. This might return fewer bytes than max.

pub fn read<E>( &self, offset: u64, len: usize, callback: impl FnMut(Vec<u8>) -> Result<usize, E>, map_err: impl FnOnce(Status) -> E, ) -> Result<usize, E>

Attempts to read len bytes and will only return fewer if it encounters the end of the file, or an error. callback will be called for each chunk. If any bytes are successfully passed to callback, read will return the total number of bytes successfully written and any error encountered will be discarded.

pub fn write(&self, offset: u64, data: &[u8]) -> Result<usize, Status>

Writes data at offset.

pub fn supports_vectored(&self) -> bool

Returns true if vectored operations are supported.

pub unsafe fn readv( &self, offset: u64, iovecs: &mut [zx_iovec_t], ) -> Result<usize, Status>

Reads into iovecs using a vectored read. This is only supported with a valid stream. See supports_vectored above.

Safety

Same as zx::Stream::readv.

pub fn writev( &self, offset: u64, iovecs: &[zx_iovec_t], ) -> Result<usize, Status>

Writes from iovecs using vectored write. This is only supported with a valid stream. See supports_vectored above.

pub fn truncate(&self, length: u64) -> Result<(), Status>

Wraps fuchsia.io/File’s Truncate.

pub fn vmo_get(&self, flags: VmarFlags) -> Result<Vmo, Status>

Returns a VMO backing the file.

pub fn sync(&self) -> Result<(), Status>

Wraps fuchsia.io/Node’s Sync.

pub fn close_and_update_access_time(self)

Closes and updates access time asynchronously.

pub fn clone_proxy(&self) -> Result<NodeSynchronousProxy, Status>

Clones (in the fuchsia.unknown.Clonable sense) the underlying proxy.

pub fn link_into(&self, target_dir: &Self, name: &str) -> Result<(), Status>

Wraps fuchsia.io/Node’s LinkInto.

pub fn unlink(&self, name: &str, flags: UnlinkFlags) -> Result<(), Status>

Wraps fuchsia.io/Directory’s Unlink.

pub fn rename( &self, old_path: &str, new_directory: &Self, new_path: &str, ) -> Result<(), Status>

Wraps fuchsia.io/Directory’s Rename.

pub fn create_symlink( &self, name: &str, target: &[u8], ) -> Result<RemoteIo, Status>

Wraps fuchsia.io/Directory’s CreateSymlink.

pub fn enable_verity( &self, descriptor: &zxio_fsverity_descriptor_t, ) -> Result<(), Status>

Wraps fuchsia.io/File’s EnableVerity.

pub fn allocate( &self, offset: u64, len: u64, mode: AllocateMode, ) -> Result<(), Status>

Wraps fuchsia.io/File’s Allocate.

pub fn xattr_get(&self, name: &[u8]) -> Result<Vec<u8>, Status>

Wraps fuchsia.io/Node’s GetExtendedAttribute.

pub fn xattr_set( &self, name: &[u8], value: &[u8], mode: XattrSetMode, ) -> Result<(), Status>

Wraps fuchsia.io/Node’s SetExtendedAttribute.

pub fn xattr_remove(&self, name: &[u8]) -> Result<(), Status>

Wraps fuchsia.io/Node’s RenoveExtendedAttribute.

pub fn xattr_list(&self) -> Result<Vec<Vec<u8>>, Status>

Wraps fuchsia.io/Node’s ListExtendedAttributes.