Trait Vfs 

pub trait Vfs: Send + Sync {
    type Source: Source + 'static;

    // Required methods
    fn get_source(&self, uri: &str) -> Option<Self::Source>;
    fn get_uri(&self, id: u32) -> Option<Arc<str>>;
    fn get_id(&self, uri: &str) -> Option<u32>;
    fn exists(&self, uri: &str) -> bool;
    fn metadata(&self, uri: &str) -> Option<FileMetadata>;
    fn read_dir(&self, uri: &str) -> Option<Vec<Arc<str>>>;

    // Provided methods
    fn is_file(&self, uri: &str) -> bool { ... }
    fn is_dir(&self, uri: &str) -> bool { ... }
    fn line_map(&self, uri: &str) -> Option<LineMap> { ... }
}

A trait for a Virtual File System that can provide source content and location mapping.

Required Associated Types

type Source: Source + 'static

The type of source returned by this VFS.

Required Methods

fn get_source(&self, uri: &str) -> Option<Self::Source>

Get the source for the given URI.

fn get_uri(&self, id: u32) -> Option<Arc<str>>

Get the URI for the given SourceId.

fn get_id(&self, uri: &str) -> Option<u32>

Get the SourceId for the given URI.

fn exists(&self, uri: &str) -> bool

Check if a path exists at the given URI.

fn metadata(&self, uri: &str) -> Option<FileMetadata>

Read the metadata for the given URI.

fn read_dir(&self, uri: &str) -> Option<Vec<Arc<str>>>

Read the contents of a directory at the given URI. Returns a list of URIs or names.

Provided Methods

fn is_file(&self, uri: &str) -> bool

Check if the given URI points to a file.

fn is_dir(&self, uri: &str) -> bool

Check if the given URI points to a directory.

fn line_map(&self, uri: &str) -> Option<LineMap>

Implementors

impl Vfs for DiskVfs

type Source = SourceText

impl Vfs for MemoryVfs

type Source = SourceText