Interface FileSystemProviderWithOpenReadWriteCloseCapability

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

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

Hierarchy (View Summary)

FileSystemProvider
- FileSystemProviderWithOpenReadWriteCloseCapability

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

close

close(fd: number): Promise<void>
Close the file with the given file descriptor.
Parameters
- fd: number
  the file descriptor to close.
Returns Promise<void>
Overrides FileSystemProvider.close
- Defined in packages/filesystem/src/common/files.ts:844

`Optional`copy

copy?(from: URI, to: URI, opts: FileOverwriteOptions): 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: URI, opts: FileDeleteOptions): 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: URI): 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: URI): 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

open

open(resource: URI, opts: FileOpenOptions): Promise<number>
Open the give file.
Parameters
- resource: URI
  The URI of the file to open.
- opts: FileOpenOptions
  Options to define if the file should be created if it does not exist yet.
Returns Promise<number>
A promise of the file descriptor that resolves after the file is open.
Overrides FileSystemProvider.open
- Defined in packages/filesystem/src/common/files.ts:838

read

read(
    fd: number,
    pos: number,
    data: Uint8Array,
    offset: number,
    length: number,
): Promise<number>
Read specified content from a given file descriptor into a data buffer.
Parameters
- fd: number
  The file descriptor referencing the file to read from.
- pos: number
  The offset from the beginning of the file from which data should be read.
- data: Uint8Array
  The buffer that the data will be written to.
- offset: number
  The offset in the buffer at which to start writing.
- length: number
  The number of bytes to read.
Returns Promise<number>
A promise of the number of bytes read.
Overrides FileSystemProvider.read
- Defined in packages/filesystem/src/common/files.ts:856

readdir

readdir(resource: URI): 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

`Optional`readFile

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

`Optional`readFileStream

readFileStream?(
    resource: URI,
    opts: FileReadStreamOptions,
    token: CancellationToken,
): 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

rename

rename(from: URI, to: URI, opts: FileOverwriteOptions): 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: URI): 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: URI,
    changes: TextDocumentContentChangeEvent[],
    opts: FileUpdateOptions,
): 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: URI, opts: WatchOptions): 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

write

write(
    fd: number,
    pos: number,
    data: Uint8Array,
    offset: number,
    length: number,
): Promise<number>
Write specified content from the data buffer to the file referenced by the given file descriptor.
Parameters
- fd: number
  The file descriptor referencing the file to write to.
- pos: number
  The offset from the beginning of the file where this data should be written.
- data: Uint8Array
- offset: number
  The part of the buffer to be read from.
- length: number
  The number of bytes to write.
Returns Promise<number>
A promise of the number of bytes written.
Overrides FileSystemProvider.write
- Defined in packages/filesystem/src/common/files.ts:867

`Optional`writeFile

writeFile?(
    resource: URI,
    content: Uint8Array,
    opts: FileWriteOptions,
): 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>
Inherited from FileSystemProvider.writeFile
- Defined in packages/filesystem/src/common/files.ts:663

Interface FileSystemProviderWithOpenReadWriteCloseCapability

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

Readonlycapabilities

ReadonlyonDidChangeCapabilities

ReadonlyonDidChangeFile

ReadonlyonFileWatchError

Methods

Optionalaccess

Parameters

Returns Promise<void>

close

Parameters

Returns Promise<void>

Optionalcopy

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<void>

OptionalfsPath

Parameters

Returns Promise<string>

mkdir

Parameters

Returns Promise<void>

open

Parameters

Returns Promise<number>

read

Parameters

Returns Promise<number>

readdir

Parameters

Returns Promise<[string, FileType][]>

OptionalreadFile

Parameters

Returns Promise<Uint8Array>

OptionalreadFileStream

Parameters

Returns ReadableStreamEvents<Uint8Array>

rename

Parameters

Returns Promise<void>

stat

Parameters

Returns Promise<Stat>

OptionalupdateFile

Parameters

Returns Promise<FileUpdateResult>

watch

Parameters

Returns Disposable

write

Parameters

Returns Promise<number>

OptionalwriteFile

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`capabilities

`Readonly`onDidChangeCapabilities

`Readonly`onDidChangeFile

`Readonly`onFileWatchError

`Optional`access

`Optional`copy

`Optional`fsPath

`Optional`readFile

`Optional`readFileStream

`Optional`updateFile

`Optional`writeFile