Interface FileSystemProviderWithFileReadWriteCapability

Subtype of FileSystemProvider that ensures that the optional functions, needed for providers that should be able to read & write files, are implemented.

interface FileSystemProviderWithFileReadWriteCapability {
    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
- FileSystemProviderWithFileReadWriteCapability

Implemented by

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>
Inherited from FileSystemProvider.access
- 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>
Inherited from FileSystemProvider.close
- 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>
Inherited from FileSystemProvider.copy
- 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>
Inherited from FileSystemProvider.delete
- 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>
Inherited from FileSystemProvider.fsPath
- 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>
Inherited from FileSystemProvider.mkdir
- 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>
Inherited from FileSystemProvider.open
- 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>
Inherited from FileSystemProvider.read
- Defined in packages/filesystem/src/common/files.ts:687

readFile

readFile(resource): Promise<Uint8Array>
Read the contents of the given file as stream.
Parameters
- resource: URI
  The URI of the file.
Returns Promise<Uint8Array>
The ReadableStreamEvents for the readable stream of the given file.
Overrides FileSystemProvider.readFile
- Defined in packages/filesystem/src/common/files.ts:793

`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>
Inherited from FileSystemProvider.readFileStream
- 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.
Inherited from FileSystemProvider.readdir
- 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>
Inherited from FileSystemProvider.rename
- 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.
Inherited from FileSystemProvider.stat
- 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>
Inherited from FileSystemProvider.updateFile
- 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.
Inherited from FileSystemProvider.watch
- 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>
Inherited from FileSystemProvider.write
- Defined in packages/filesystem/src/common/files.ts:693

writeFile

writeFile(resource, content, opts): Promise<void>
Write data to a file, replacing its entire contents.
Parameters
- resource: URI
  The uri of the file.
- content: Uint8Array
  The new content of the file.
- opts: FileWriteOptions
  Options to define if the file should be created if missing and if an existing file should be overwritten.
Returns Promise<void>
Overrides FileSystemProvider.writeFile
- Defined in packages/filesystem/src/common/files.ts:801

Interface FileSystemProviderWithFileReadWriteCapability

Hierarchy (view full)

Implemented by

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>

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>

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` readFileStream

`Optional` updateFile

`Optional` write