Trait FileSystem

Source

pub trait FileSystem {
    type FileSystemImpl: FileSystem;

    // Required methods
    fn new(uri: &Iri<'_>, conf: &Configuration) -> Result<Self::FileSystemImpl>;
    fn resolve_symlinks(&self) -> bool;
    fn get_uri(&self) -> Iri<'_>;
    fn get_home_directory(&self) -> Result<Path>;
    fn get_working_directory(&self) -> &Path;
    fn mkdirs(
        &self,
        f: &Path,
        permission: Option<&FsPermission>,
    ) -> Result<bool>;

    // Provided methods
    fn get_resolve_symlinks(conf: &Configuration) -> bool { ... }
    fn get_default_uri(conf: &Configuration) -> Result<Iri<'_>> { ... }
    fn get_scheme(&self) -> Result<&str> { ... }
    fn fix_relative_part(&self, p: &Path) -> Result<Path> { ... }
}

Expand description

An abstract base class for a fairly generic filesystem. It may be implemented as a distributed filesystem, or as a “local” one that reflects the locally-connected disk. The local version exists for small Hadoop instances and for testing.

Required Associated Types§

Source

type FileSystemImpl: FileSystem

Required Methods§

Source

fn new(uri: &Iri<'_>, conf: &Configuration) -> Result<Self::FileSystemImpl>

Source

fn resolve_symlinks(&self) -> bool

Should symbolic links be resolved by FileSystemLinkResolver.

Source

fn get_uri(&self) -> Iri<'_>

Returns a URI which identifies this FileSystem.

Source

fn get_home_directory(&self) -> Result<Path>

Return the current user’s home directory in this FileSystem. The default implementation returns "/user/$USER/".

Source

fn get_working_directory(&self) -> &Path

Get the current working directory for the given FileSystem

Source

fn mkdirs(&self, f: &Path, permission: Option<&FsPermission>) -> Result<bool>

Make the given file and all non-existent parents into directories. Has roughly the semantics of Unix mkdir -p. Existence of the directory hierarchy is not an error.