Interface FileSystemProvider

A FileSystemProvider provides the capabilities to read, write, discover, and to manage files and folders of the underlying (potentially virtual) file system. FileSystemProviders can be used to serve files from both the local disk as well as remote locations like ftp-servers, REST-services etc. A FileSystemProvider is registered for a certain scheme and can handle all resources whose uri does conform to that scheme.

interface FileSystemProvider {
    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)

FileSystemProvider

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

`Optional` access

access(resource, mode?): Promise<void>
Optional function that has to be implemented by FileSystemProviderWithAccessCapability. See FileSystemProviderWithAccessCapability#access for additional documentation.
Parameters
- resource: URI
- Optional mode: number
Returns Promise<void>
- Defined in packages/filesystem/src/common/files.ts:699

`Optional` close

close(fd): Promise<void>
Optional function that has to be implemented by FileSystemProviderWithOpenReadWriteCloseCapability. See FileSystemProviderWithOpenReadWriteCloseCapability#close for additional documentation.
Parameters
- fd: number
Returns Promise<void>
- Defined in packages/filesystem/src/common/files.ts:681

`Optional` copy

copy(from, to, opts): Promise<void>
Optional function that has to be implemented by FileSystemProviderWithFileFolderCopyCapability. See FileSystemProviderWithFileFolderCopyCapability#copy} for additional documentation.
Parameters
- from: URI
- to: URI
- opts: FileOverwriteOptions
Returns Promise<void>
- Defined in packages/filesystem/src/common/files.ts:651

delete

delete(resource, opts): Promise<void>
Delete the given resource.
Parameters
- resource: URI
  The URI of the resource to delete.
- opts: FileDeleteOptions
  Options to define if files should be deleted recursively and if the trash should be used.
Returns Promise<void>
- Defined in packages/filesystem/src/common/files.ts:637

`Optional` fsPath

fsPath(resource): Promise<string>
Optional function that has to be implemented by FileSystemProviderWithAccessCapability. See FileSystemProviderWithAccessCapability#fsPath for additional documentation.
Parameters
- resource: URI
Returns Promise<string>
- Defined in packages/filesystem/src/common/files.ts:705

mkdir

mkdir(resource): Promise<void>
Create a new directory using the given resource uri.
Parameters
- resource: URI
  The URI of the new folder.
Returns Promise<void>
- Defined in packages/filesystem/src/common/files.ts:622

`Optional` open

open(resource, opts): Promise<number>
Optional function that has to be implemented by FileSystemProviderWithOpenReadWriteCloseCapability. See FileSystemProviderWithOpenReadWriteCloseCapability#open for additional documentation.
Parameters
- resource: URI
- opts: FileOpenOptions
Returns Promise<number>
- Defined in packages/filesystem/src/common/files.ts:675

`Optional` read

read(fd, pos, data, offset, length): Promise<number>
Optional function that has to be implemented by FileSystemProviderWithOpenReadWriteCloseCapability. See FileSystemProviderWithOpenReadWriteCloseCapability#read for additional documentation.
Parameters
- fd: number
- pos: number
- data: Uint8Array
- offset: number
- length: number
Returns Promise<number>
- Defined in packages/filesystem/src/common/files.ts:687

`Optional` readFile

readFile(resource): Promise<Uint8Array>
Optional function that has to be implemented by FileSystemProviderWithFileReadWriteCapability. See FileSystemProviderWithFileReadWriteCapability#readFile for additional documentation.
Parameters
- resource: URI
Returns Promise<Uint8Array>
- Defined in packages/filesystem/src/common/files.ts:657

`Optional` readFileStream

readFileStream(resource, opts, token): ReadableStreamEvents<Uint8Array>
Optional function that has to be implemented by FileSystemProviderWithFileReadStreamCapability. See FileSystemProviderWithFileReadStreamCapability#readFileStream for additional documentation.
Parameters
- resource: URI
- opts: FileReadStreamOptions
- token: CancellationToken
Returns ReadableStreamEvents<Uint8Array>
- Defined in packages/filesystem/src/common/files.ts:669

readdir

readdir(resource): Promise<[string, FileType][]>
Retrieve the content of a given directory.
Parameters
- resource: URI
  The URI of the directory.
Returns Promise<[string, FileType][]>
A map containing the FileType for each child resource, identified by name.
- Defined in packages/filesystem/src/common/files.ts:630

rename

rename(from, to, opts): Promise<void>
Rename a file or folder.
Parameters
- from: URI
  URI of the existing file or folder.
- to: URI
  URI of the target location.
- opts: FileOverwriteOptions
  Options to define if existing files should be overwritten.
Returns Promise<void>
- Defined in packages/filesystem/src/common/files.ts:645

stat

stat(resource): Promise<Stat>
Retrieve metadata about a given file.
Parameters
- resource: URI
Returns Promise<Stat>
A promise of the metadata about the resource.
- Defined in packages/filesystem/src/common/files.ts:616

`Optional` updateFile

updateFile(resource, changes, opts): Promise<FileUpdateResult>
Optional function that has to be implemented by FileSystemProviderWithUpdateCapability. See FileSystemProviderWithUpdateCapability#updateFile for additional documentation.
Parameters
- resource: URI
- changes: TextDocumentContentChangeEvent[]
- opts: FileUpdateOptions
Returns Promise<FileUpdateResult>
- Defined in packages/filesystem/src/common/files.ts:711

watch

watch(resource, opts): Disposable
Watch the given resource and react to changes by firing the FileSystemProvider#onDidChangeFile event.
Parameters
- resource: URI
  URI of the resource to be watched.
- opts: WatchOptions
  Options to define if the resource should be watched recursively and to provide a set of resources that should be excluded from watching.
Returns Disposable
A Disposable that can be invoked to stop watching the resource.
- Defined in packages/filesystem/src/common/files.ts:608

`Optional` write

write(fd, pos, data, offset, length): Promise<number>
Optional function that has to be implemented by FileSystemProviderWithOpenReadWriteCloseCapability. See FileSystemProviderWithOpenReadWriteCloseCapability#write for additional documentation.
Parameters
- fd: number
- pos: number
- data: Uint8Array
- offset: number
- length: number
Returns Promise<number>
- Defined in packages/filesystem/src/common/files.ts:693

`Optional` writeFile

writeFile(resource, content, opts): Promise<void>
Optional function that has to be implemented by FileSystemProviderWithFileReadWriteCapability. See FileSystemProviderWithFileReadWriteCapability#writeFile for additional documentation.
Parameters
- resource: URI
- content: Uint8Array
- opts: FileWriteOptions
Returns Promise<void>
- Defined in packages/filesystem/src/common/files.ts:663

Interface FileSystemProvider

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonly capabilities

Readonly onDidChangeCapabilities

Readonly onDidChangeFile

Readonly onFileWatchError

Methods

Optional access

Parameters

Returns Promise<void>

Optional close

Parameters

Returns Promise<void>

Optional copy

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<void>

Optional fsPath

Parameters

Returns Promise<string>

mkdir

Parameters

Returns Promise<void>

Optional open

Parameters

Returns Promise<number>

Optional read

Parameters

Returns Promise<number>

Optional readFile

Parameters

Returns Promise<Uint8Array>

Optional readFileStream

Parameters

Returns ReadableStreamEvents<Uint8Array>

readdir

Parameters

Returns Promise<[string, FileType][]>

rename

Parameters

Returns Promise<void>

stat

Parameters

Returns Promise<Stat>

Optional updateFile

Parameters

Returns Promise<FileUpdateResult>

watch

Parameters

Returns Disposable

Optional write

Parameters

Returns Promise<number>

Optional writeFile

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Readonly` capabilities

`Readonly` onDidChangeCapabilities

`Readonly` onDidChangeFile

`Readonly` onFileWatchError

`Optional` access

`Optional` close

`Optional` copy

`Optional` fsPath

`Optional` open

`Optional` read

`Optional` readFile

`Optional` readFileStream

`Optional` updateFile

`Optional` write

`Optional` writeFile