Trait FileSystem 

pub trait FileSystem: Send + Sync {
    // Required methods
    fn new(yarn_pnp: bool) -> Self;
    fn read_to_string(&self, path: &Path) -> Result<String>;
    fn metadata(&self, path: &Path) -> Result<FileMetadata>;
    fn symlink_metadata(&self, path: &Path) -> Result<FileMetadata>;
    fn read_link(&self, path: &Path) -> Result<PathBuf, ResolveError>;

    // Provided method
    fn read_to_string_bypass_system_cache(&self, path: &Path) -> Result<String> { ... }
}

File System abstraction used for ResolverGeneric

Required Methods

fn new(yarn_pnp: bool) -> Self

fn read_to_string(&self, path: &Path) -> Result<String>

See std::fs::read_to_string

Errors

• See std::fs::read_to_string

Warning

Use &Path instead of a generic P: AsRef<Path> here, because object safety requirements, it is especially useful, when you want to store multiple dyn FileSystem in a Vec or use a ResolverGeneric<Fs> in napi env.

fn metadata(&self, path: &Path) -> Result<FileMetadata>

See std::fs::metadata

Errors

See std::fs::metadata

Warning

Use &Path instead of a generic P: AsRef<Path> here, because object safety requirements, it is especially useful, when you want to store multiple dyn FileSystem in a Vec or use a ResolverGeneric<Fs> in napi env.

fn symlink_metadata(&self, path: &Path) -> Result<FileMetadata>

See std::fs::symlink_metadata

Errors

See std::fs::symlink_metadata

Warning

Use &Path instead of a generic P: AsRef<Path> here, because object safety requirements, it is especially useful, when you want to store multiple dyn FileSystem in a Vec or use a ResolverGeneric<Fs> in napi env.

fn read_link(&self, path: &Path) -> Result<PathBuf, ResolveError>

Returns the resolution of a symbolic link.

Errors

• Returns an error of ResolveError::IOError kind if there is an IO error invoking std::fs::read_link.
• Returns an error of ResolveError::PathNotSupported kind if the symlink target cannot be represented as a path that can be consumed by the import/require syntax of Node.js. Caller should not try to follow the symlink in this case.

See std::fs::read_link

Provided Methods

fn read_to_string_bypass_system_cache(&self, path: &Path) -> Result<String>

Reads a file while bypassing the system cache.

This is useful in scenarios where the file content is already cached in memory and you want to avoid the overhead of using the system cache.

Errors

• See std::fs::read_to_string

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl FileSystem for FileSystemOs