language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-27 20:42:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

[red-knot] Improve Vfs and FileSystem documentation (#11856)

Browse source
This commit is contained in:
Micha Reiser 2024-06-13 12:49:27 +01:00 • committed by GitHub
parent 73370fe798
commit c5bc368e43
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

11
crates/ruff_db/src/file_system.rs
View file

@ -13,11 +13,14 @@ mod os;
pub type Result<T> = std::io::Result<T>; pub type Result<T> = std::io::Result<T>;
/// A file system that can be used to read and write files. /// An abstraction over `std::fs` with features tailored to Ruff's needs.
/// ///
/// The file system is agnostic to the actual storage medium, it could be a real file system, a combination /// Provides a file system agnostic API to interact with files and directories.
/// of a real file system and an in-memory file system in the case of an LSP where unsaved changes are stored in memory, /// Abstracting the file system operations enables:
/// or an all in-memory file system for testing. ///
/// * Accessing unsaved or even untitled files in the LSP use case
/// * Testing with an in-memory file system
/// * Running Ruff in a WASM environment without needing to stub out the full `std::fs` API.
pub trait FileSystem { pub trait FileSystem {
/// Reads the metadata of the file or directory at `path`. /// Reads the metadata of the file or directory at `path`.
fn metadata(&self, path: &FileSystemPath) -> Result<Metadata>; fn metadata(&self, path: &FileSystemPath) -> Result<Metadata>;

6
crates/ruff_db/src/vfs.rs
View file

@ -38,7 +38,7 @@ pub struct Vfs {
#[derive(Default)] #[derive(Default)]
struct VfsInner { struct VfsInner {
/// Lookup table that maps the path to a salsa interned [`VfsFile`] instance. /// Lookup table that maps [`VfsPath`]s to salsa interned [`VfsFile`] instances.
/// ///
/// The map also stores entries for files that don't exist on the file system. This is necessary /// The map also stores entries for files that don't exist on the file system. This is necessary
/// so that queries that depend on the existence of a file are re-executed when the file is created. /// so that queries that depend on the existence of a file are re-executed when the file is created.
@ -93,7 +93,7 @@ impl Vfs {
}) })
} }
/// Lookups a vendored file by its path. Returns `Some` if a vendored file for the given path /// Looks up a vendored file by its path. Returns `Some` if a vendored file for the given path
/// exists and `None` otherwise. /// exists and `None` otherwise.
pub fn vendored(&self, db: &dyn Db, path: &VendoredPath) -> Option<VfsFile> { pub fn vendored(&self, db: &dyn Db, path: &VendoredPath) -> Option<VfsFile> {
let file = match self let file = match self
@ -144,7 +144,7 @@ impl Vfs {
} }
/// Creates a salsa like snapshot of the files. The instances share /// Creates a salsa like snapshot of the files. The instances share
/// the same path to file mapping. /// the same path-to-file mapping.
pub fn snapshot(&self) -> Self { pub fn snapshot(&self) -> Self {
Self { Self {
inner: self.inner.clone(), inner: self.inner.clone(),