RemoteFileSystemProvider

Frontend component.

Wraps the remote filesystem provider living on the backend.

Hierarchy

RemoteFileSystemProvider

Implements

Required<FileSystemProvider>
Disposable

Constructors

constructor

new RemoteFileSystemProvider(): RemoteFileSystemProvider

Returns RemoteFileSystemProvider

Properties

Private _capabilities

_capabilities: FileSystemProviderCapabilities = 0

Readonly onDidChangeCapabilities

onDidChangeCapabilities: Event<void> = ...

Private Readonly onDidChangeCapabilitiesEmitter

onDidChangeCapabilitiesEmitter: Emitter<void> = ...

Readonly onDidChangeFile

onDidChangeFile: Event<readonly FileChange[]> = ...

Private Readonly onDidChangeFileEmitter

onDidChangeFileEmitter: Emitter<readonly FileChange[]> = ...

Private Readonly onFileStreamData

onFileStreamData: Event<[number, Uint8Array]> = ...

Private Readonly onFileStreamDataEmitter

onFileStreamDataEmitter: Emitter<[number, Uint8Array]> = ...

Private Readonly onFileStreamEnd

onFileStreamEnd: Event<[number, undefined | Error | FileSystemProviderError]> = ...

Private Readonly onFileStreamEndEmitter

onFileStreamEndEmitter: Emitter<[number, undefined | Error | FileSystemProviderError]> = ...

Readonly onFileWatchError

onFileWatchError: Event<void> = ...

Private Readonly onFileWatchErrorEmitter

onFileWatchErrorEmitter: Emitter<void> = ...

Readonly ready

ready: Promise<void> = ...

Protected Readonly readyDeferred

readyDeferred: Deferred<void> = ...

Protected Readonly server

server: JsonRpcProxy<RemoteFileSystemServer>

Wrapped remote filesystem.

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly watchOptions

watchOptions: Map<number, { options: WatchOptions; uri: string }> = ...

We'll track the currently allocated watchers, in order to re-allocate them with the same options once we reconnect to the backend after a disconnection.

Protected watcherSequence

watcherSequence: number = 0

Accessors

capabilities

get capabilities(): FileSystemProviderCapabilities

Implementation of Required.capabilities
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:147
Returns FileSystemProviderCapabilities

Methods

access

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

Implementation of Required.access
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:197
Parameters
- resource: URI
- Optional mode: number
Returns Promise<void>

close

close(fd: number): Promise<void>

Implementation of Required.close
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:209
Parameters
- fd: number
Returns Promise<void>

copy

copy(resource: URI, target: URI, opts: FileOverwriteOptions): Promise<void>

Implementation of Required.copy
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:290
Parameters
- resource: URI
- target: URI
- opts: FileOverwriteOptions
Returns Promise<void>

delete

delete(resource: URI, opts: FileDeleteOptions): Promise<void>

Implementation of Required.delete
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:274
Parameters
- resource: URI
- opts: FileDeleteOptions
Returns Promise<void>

dispose

dispose(): void

Implementation of Disposable.dispose
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:182
Returns void

fsPath

fsPath(resource: URI): Promise<string>

Implementation of Required.fsPath
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:201
Parameters
- resource: URI
Returns Promise<string>

Protected init

init(): void

- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:159
Returns void

mkdir

mkdir(resource: URI): Promise<void>

Implementation of Required.mkdir
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:278
Parameters
- resource: URI
Returns Promise<void>

open

open(resource: URI, opts: FileOpenOptions): Promise<number>

Implementation of Required.open
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:205
Parameters
- resource: URI
- opts: FileOpenOptions
Returns Promise<number>

read

read(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>

Implementation of Required.read
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:213
Parameters
- fd: number
- pos: number
- data: Uint8Array
- offset: number
- length: number
Returns Promise<number>

readFile

readFile(resource: URI): Promise<Uint8Array>

Implementation of Required.readFile
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:225
Parameters
- resource: URI
Returns Promise<Uint8Array>

readFileStream

readFileStream(resource: URI, opts: FileReadStreamOptions, token: CancellationToken): ReadableStreamEvents<Uint8Array>

Implementation of Required.readFileStream
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:230
Parameters
- resource: URI
- opts: FileReadStreamOptions
- token: CancellationToken
Returns ReadableStreamEvents<Uint8Array>

readdir

readdir(resource: URI): Promise<[string, FileType][]>

Implementation of Required.readdir
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:282
Parameters
- resource: URI
Returns Promise<[string, FileType][]>

Protected reconnect

reconnect(): void

- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:316
When a frontend disconnects (e.g. bad connection) the backend resources will be cleared.

This means that we need to re-allocate the watchers when a frontend reconnects.

Returns void

rename

rename(resource: URI, target: URI, opts: FileOverwriteOptions): Promise<void>

Implementation of Required.rename
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:286
Parameters
- resource: URI
- target: URI
- opts: FileOverwriteOptions
Returns Promise<void>

Protected setCapabilities

setCapabilities(capabilities: FileSystemProviderCapabilities): void

- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:186
Parameters
- capabilities: FileSystemProviderCapabilities
Returns void

stat

stat(resource: URI): Promise<Stat>

Implementation of Required.stat
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:193
Parameters
- resource: URI
Returns Promise<Stat>

updateFile

updateFile(resource: URI, changes: TextDocumentContentChangeEvent[], opts: FileUpdateOptions): Promise<FileUpdateResult>

Implementation of Required.updateFile
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:294
Parameters
- resource: URI
- changes: TextDocumentContentChangeEvent[]
- opts: FileUpdateOptions
Returns Promise<FileUpdateResult>

watch

watch(resource: URI, options: WatchOptions): Disposable

Implementation of Required.watch
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:298
Parameters
- resource: URI
- options: WatchOptions
Returns Disposable

write

write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>

Implementation of Required.write
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:266
Parameters
- fd: number
- pos: number
- data: Uint8Array
- offset: number
- length: number
Returns Promise<number>

writeFile

writeFile(resource: URI, content: Uint8Array, opts: FileWriteOptions): Promise<void>

Implementation of Required.writeFile
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:270
Parameters
- resource: URI
- content: Uint8Array
- opts: FileWriteOptions
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns RemoteFileSystemProvider

Properties

Private _capabilities

Readonly onDidChangeCapabilities

Private Readonly onDidChangeCapabilitiesEmitter

Readonly onDidChangeFile

Private Readonly onDidChangeFileEmitter

Private Readonly onFileStreamData

Private Readonly onFileStreamDataEmitter

Private Readonly onFileStreamEnd

Private Readonly onFileStreamEndEmitter

Readonly onFileWatchError

Private Readonly onFileWatchErrorEmitter

Readonly ready

Protected Readonly readyDeferred

Protected Readonly server

Protected Readonly toDispose

Protected Readonly watchOptions

Protected watcherSequence

Accessors

capabilities

Returns FileSystemProviderCapabilities

Methods

access

Parameters

resource: URI

Optional mode: number

Returns Promise<void>

close

Parameters

fd: number

Returns Promise<void>

copy

Parameters

resource: URI

target: URI

opts: FileOverwriteOptions

Returns Promise<void>

delete

Parameters

resource: URI

opts: FileDeleteOptions

Returns Promise<void>

dispose

Returns void

fsPath

Parameters

resource: URI

Returns Promise<string>

Protected init

Returns void

mkdir

Parameters

resource: URI

Returns Promise<void>

open

Parameters

resource: URI

opts: FileOpenOptions

Returns Promise<number>

read

Parameters

fd: number

pos: number

data: Uint8Array

offset: number

length: number

Returns Promise<number>

readFile

Parameters

resource: URI