Struct File 

pub struct File<T = TokioTcpTransport> { /* private fields */ }

One open file handle on a tree-connected share.

Implementations

impl<T> File<T>

where T: SmbTransport + Send,

pub fn path(&self) -> &str

Returns the file path relative to the connected share.

pub fn file_id(&self) -> FileId

Returns the active SMB file identifier.

pub fn durable_handle(&self) -> Option<&DurableHandle>

Returns the durable reconnect state captured for this file, if requested.

pub fn resilient_handle(&self) -> Option<ResilientHandle>

Returns the resiliency state captured for this file, if requested.

pub fn connection(&self) -> &Connection<T, TreeConnected>

Returns the wrapped tree-connected connection.

pub fn connection_mut(&mut self) -> &mut Connection<T, TreeConnected>

Returns a mutable reference to the wrapped tree-connected connection.

pub async fn read_all(&mut self) -> Result<Vec<u8>, CoreError>

Reads the full contents of the open file.

pub async fn read_to_end(&mut self) -> Result<Vec<u8>, CoreError>

Reads the full contents of the open file.

This is an alias for File::read_all that matches the standard async I/O naming convention used by Rust callers.

pub async fn write_all(&mut self, data: &[u8]) -> Result<(), CoreError>

Writes the full provided buffer to the open file starting at offset zero.

pub async fn flush(&mut self) -> Result<(), CoreError>

Flushes the open file handle.

pub async fn sync_all(&mut self) -> Result<(), CoreError>

Flushes all buffered SMB state for the open file handle.

This is an alias for File::flush that matches common filesystem terminology used by embedders.

pub async fn stat(&mut self) -> Result<FileMetadata, CoreError>

Queries metadata for the open file handle.

pub async fn request_resiliency( &mut self, timeout: u32, ) -> Result<ResilientHandle, CoreError>

Requests handle resiliency for the current file and stores the result for future reconnects.

pub async fn close(self) -> Result<Share<T>, CoreError>

Closes the file and returns the tree-connected share wrapper.

pub fn into_parts( self, ) -> (Share<T>, FileId, Option<DurableHandle>, Option<ResilientHandle>)

Consumes the file wrapper and returns the share wrapper plus low-level file state.

Trait Implementations

impl<T: Debug> Debug for File<T>

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

Formats the value using the given formatter.