Struct VirtualFile 

pub struct VirtualFile { /* private fields */ }

Describes one virtual file exposed to a receiving application.

A virtual file consists of a name, an optional known size, and a crate::FileSource that supplies its contents on demand. The file need not exist as a physical file on the source machine.

Implementations

impl VirtualFile

pub fn new(name: &str, source: Box<dyn FileSource>) -> Result<Self>

Creates a virtual file with an unknown size.

name may be a relative path such as reports/2026/report.txt. The name and its path components are validated for the target platform. A separate transfer-level check rejects duplicate or conflicting paths.

Errors

Returns crate::Error::InvalidInput when the name is empty or invalid.

pub fn name(&self) -> &str

Returns the virtual file’s name or relative destination path.

pub fn size(&self) -> Option<u64>

Returns the explicitly supplied size, if any.

None does not imply an empty file. A seekable source may still provide its length when opened by the receiving application.

pub fn with_size(self, size: u64) -> Self

Sets the advertised size in bytes and returns the updated file.

This does not inspect the source. The caller is responsible for ensuring the declared size matches the bytes the source provides.