Struct Zxio 

pub struct Zxio { /* private fields */ }

A handle to a zxio object.

Note: the underlying storage backing the object is pinned on the heap because it can contain self referential data.

Implementations

impl Zxio

pub fn new_socket<S: ServiceConnector>( domain: c_int, socket_type: c_int, protocol: c_int, _: ZxioSocketCreationOptions<'_>, ) -> Result<Result<Self, ZxioErrorCode>, Status>

pub fn create(handle: NullableHandle) -> Result<Zxio, Status>

pub fn release(self) -> Result<NullableHandle, Status>

pub fn with_token_resolver(self, resolver: Arc<dyn ZxioTokenResolver>) -> Self

Updates self with a new token resolver. Can be called only when there are no weak references to self.

pub fn open( &self, path: &str, flags: Flags, options: ZxioOpenOptions<'_, '_>, ) -> Result<Self, Status>

pub fn create_with_on_representation( handle: NullableHandle, attributes: Option<&mut zxio_node_attributes_t>, ) -> Result<Zxio, Status>

pub fn open_node( &self, path: &str, flags: Flags, attributes: Option<&mut zxio_node_attributes_t>, ) -> Result<Self, Status>

Opens a limited node connection (similar to O_PATH).

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

pub fn read(&self, data: &mut [u8]) -> Result<usize, Status>

pub unsafe fn readv(&self, data: &[zx_iovec]) -> Result<usize, Status>

Performs a vectorized read, returning the number of bytes read to data.

Safety

The caller must check the returned Result to make sure the buffers provided are valid. The caller must provide pointers that are compatible with the backing implementation of zxio.

This call allows writing to arbitrary memory locations. It is up to the caller to make sure that calling this method does not result in undefined behaviour.

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

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

pub fn downgrade(&self) -> ZxioWeak

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

pub unsafe fn readv_at( &self, offset: u64, data: &[zx_iovec], ) -> Result<usize, Status>

Performs a vectorized read at an offset, returning the number of bytes read to data.

Safety

The caller must check the returned Result to make sure the buffers provided are valid. The caller must provide pointers that are compatible with the backing implementation of zxio.

This call allows writing to arbitrary memory locations. It is up to the caller to make sure that calling this method does not result in undefined behaviour.

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

pub unsafe fn writev(&self, data: &[zx_iovec]) -> Result<usize, Status>

Performs a vectorized write, returning the number of bytes written from data.

Safety

The caller must check the returned Result to make sure the buffers provided are valid. The caller must provide pointers that are compatible with the backing implementation of zxio.

This call allows reading from arbitrary memory locations. It is up to the caller to make sure that calling this method does not result in undefined behaviour.

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

pub unsafe fn writev_at( &self, offset: u64, data: &[zx_iovec], ) -> Result<usize, Status>

Performs a vectorized write at an offset, returning the number of bytes written from data.

Safety

The caller must check the returned Result to make sure the buffers provided are valid. The caller must provide pointers that are compatible with the backing implementation of zxio.

This call allows reading from arbitrary memory locations. It is up to the caller to make sure that calling this method does not result in undefined behaviour.

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

pub fn seek( &self, seek_origin: SeekOrigin, offset: i64, ) -> Result<usize, Status>

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

pub fn attr_get( &self, query: zxio_node_attr_has_t, ) -> Result<zxio_node_attributes_t, Status>

pub fn close_and_update_access_time(self) -> Result<(), Status>

pub fn attr_get_with_root_hash( &self, query: zxio_node_attr_has_t, fsverity_root_hash: &mut [u8; 64], ) -> Result<zxio_node_attributes_t, Status>

Assumes that the caller has set query.fsverity_root_hash to true.

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

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

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

pub fn wait_begin( &self, zxio_signals: zxio_signals_t, ) -> (Unowned<'_, NullableHandle>, Signals)

pub fn wait_end(&self, signals: Signals) -> zxio_signals_t

pub fn create_dirent_iterator(&self) -> Result<DirentIterator<'_>, Status>

pub fn connect(&self, addr: &[u8]) -> Result<Result<(), ZxioErrorCode>, Status>

pub fn bind(&self, addr: &[u8]) -> Result<Result<(), ZxioErrorCode>, Status>

pub fn listen(&self, backlog: i32) -> Result<Result<(), ZxioErrorCode>, Status>

pub fn accept(&self) -> Result<Result<Zxio, ZxioErrorCode>, Status>

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

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

pub fn getsockopt_slice( &self, level: u32, optname: u32, optval: &mut [u8], ) -> Result<Result<socklen_t, ZxioErrorCode>, Status>

pub fn getsockopt( &self, level: u32, optname: u32, optlen: socklen_t, ) -> Result<Result<Vec<u8>, ZxioErrorCode>, Status>

pub fn setsockopt( &self, level: i32, optname: i32, optval: &[u8], ) -> Result<Result<(), ZxioErrorCode>, Status>

pub fn shutdown( &self, flags: ZxioShutdownFlags, ) -> Result<Result<(), ZxioErrorCode>, Status>

pub fn sendmsg( &self, addr: &mut [u8], buffer: &mut [iovec], cmsg: &[ControlMessage], flags: u32, ) -> Result<Result<usize, ZxioErrorCode>, Status>

pub fn recvmsg( &self, buffer: &mut [iovec], flags: u32, ) -> Result<Result<RecvMessageInfo, ZxioErrorCode>, Status>

pub fn read_link(&self) -> Result<&[u8], Status>

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for Zxio

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Zxio

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

Formats the value using the given formatter.

impl Default for Zxio

fn default() -> Self

Returns the “default value” for a type.