Interface FileSystemProviderWithAccessCapability

Subtype of FileSystemProvider that ensures that the optional functions needed for providers, that should be able access files, are implemented.

interface FileSystemProviderWithAccessCapability {
    capabilities: FileSystemProviderCapabilities;
    onDidChangeCapabilities: Event<void>;
    onDidChangeFile: Event<readonly FileChange[]>;
    onFileWatchError: Event<void>;
    access(resource, mode?): Promise<void>;
    close?(fd): Promise<void>;
    copy?(from, to, opts): Promise<void>;
    delete(resource, opts): Promise<void>;
    fsPath(resource): Promise<string>;
    mkdir(resource): Promise<void>;
    open?(resource, opts): Promise<number>;
    read?(fd, pos, data, offset, length): Promise<number>;
    readFile?(resource): Promise<Uint8Array>;
    readFileStream?(resource, opts, token): ReadableStreamEvents<Uint8Array>;
    readdir(resource): Promise<[string, FileType][]>;
    rename(from, to, opts): Promise<void>;
    stat(resource): Promise<Stat>;
    updateFile?(resource, changes, opts): Promise<FileUpdateResult>;
    watch(resource, opts): Disposable;
    write?(fd, pos, data, offset, length): Promise<number>;
    writeFile?(resource, content, opts): Promise<void>;
}

Hierarchy (view full)

Properties

capabilities onDidChangeCapabilities onDidChangeFile onFileWatchError

Methods

access close? copy? delete fsPath mkdir open? read? readFile? readFileStream? readdir rename stat updateFile? watch write? writeFile?

Properties

Readonly capabilities

capabilities: FileSystemProviderCapabilities

The FileSystemProviderCapabilities for this provider.

Readonly onDidChangeCapabilities

onDidChangeCapabilities: Event<void>
  • Event that is fired if the capabilities of this provider have changed.

Readonly onDidChangeFile

onDidChangeFile: Event<readonly FileChange[]>

Event that is fired if a (watched) file in the filesystem of this provider has changed.

Readonly onFileWatchError

onFileWatchError: Event<void>

Event that is fired if an error occurred when watching files in the filesystem of this provider.

Methods

access

  • access(resource, mode?): Promise<void>

  • Tests a user's permissions for the file or directory specified by URI.

    Parameters

    • resource: URI

      The URI of the file that should be tested.

    • Optional mode: number

      An optional integer that specifies the accessibility checks to be performed. Check FileAccess.Constants for possible values of mode. It is possible to create a mask consisting of the bitwise OR of two or more values (e.g. FileAccess.Constants.W_OK | FileAccess.Constants.R_OK). If mode is not defined, FileAccess.Constants.F_OK will be used instead.

    Returns Promise<void>

    A promise that resolves if the user has the required permissions, should be rejected otherwise.

Optional close

Optional copy

delete

fsPath

  • fsPath(resource): Promise<string>

  • Returns the path of the given file URI, specific to the backend's operating system. If the URI is not a file URI, undefined is returned.

    USE WITH CAUTION: You should always prefer URIs to paths if possible, as they are portable and platform independent. Paths should only be used in cases you directly interact with the OS, e.g. when running a command on the shell.

    Parameters

    • resource: URI

      URI of the resource to derive the path from.

    Returns Promise<string>

    A promise of the corresponding file system path.

mkdir

Optional open

Optional read

Optional readFile

Optional readFileStream

readdir

rename

stat

Optional updateFile

watch

Optional write

Optional writeFile

Settings

Member Visibility

Theme

On This Page

capabilitiesonDidChangeCapabilitiesonDidChangeFileonFileWatchErroraccessclosecopydeletefsPathmkdiropenreadreadFilereadFileStreamreaddirrenamestatupdateFilewatchwritewriteFile