Class RemoteFileSystemProvider

Frontend component.

Wraps the remote filesystem provider living on the backend.

Implements

Constructors

constructor

new RemoteFileSystemProvider(): RemoteFileSystemProvider
Returns RemoteFileSystemProvider

Properties

`Private` _capabilities

_capabilities: FileSystemProviderCapabilities = FileSystemProviderCapabilities.None

`Private` _readOnlyMessage

_readOnlyMessage: undefined | MarkdownString = undefined

`Readonly` onDidChangeCapabilities

onDidChangeCapabilities: Event<void> = ...

`Private` `Readonly` onDidChangeCapabilitiesEmitter

onDidChangeCapabilitiesEmitter: Emitter<void> = ...

`Readonly` onDidChangeFile

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

`Private` `Readonly` onDidChangeFileEmitter

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

`Readonly` onDidChangeReadOnlyMessage

onDidChangeReadOnlyMessage: Event<undefined | MarkdownString> = ...

`Private` `Readonly` onDidChangeReadOnlyMessageEmitter

onDidChangeReadOnlyMessageEmitter: Emitter<undefined | MarkdownString> = ...

`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: RpcProxy<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.

Type declaration

options: WatchOptions
uri: string

`Protected` watcherSequence

watcherSequence: number = 0

Accessors

capabilities

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

readOnlyMessage

get readOnlyMessage(): undefined | MarkdownString
Returns undefined | MarkdownString
Implementation of ReadOnlyMessageFileSystemProvider.readOnlyMessage
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:158

Methods

access

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

close

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

copy

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

delete

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

dispose

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

fsPath

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

`Protected` init

init(): void
Returns void
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:172

mkdir

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

open

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

read

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

readFile

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

readFileStream

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

readdir

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

`Protected` reconnect

reconnect(): void
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
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:338

rename

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

`Protected` setCapabilities

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

`Protected` setReadOnlyMessage

setReadOnlyMessage(readOnlyMessage): void
Parameters
- readOnlyMessage: undefined | MarkdownString
Returns void
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:208

stat

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

updateFile

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

watch

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

write

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

writeFile

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

Class RemoteFileSystemProvider

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns RemoteFileSystemProvider

Properties

Private _capabilities

Private _readOnlyMessage

Readonly onDidChangeCapabilities

Private Readonly onDidChangeCapabilitiesEmitter

Readonly onDidChangeFile

Private Readonly onDidChangeFileEmitter

Readonly onDidChangeReadOnlyMessage

Private Readonly onDidChangeReadOnlyMessageEmitter

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

Type declaration

options: WatchOptions

uri: string

Protected watcherSequence

Accessors

capabilities

Returns FileSystemProviderCapabilities

readOnlyMessage

Returns undefined | MarkdownString

Methods

access

Parameters

Returns Promise<void>

close

Parameters

Returns Promise<void>

copy

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<void>

dispose

Returns void

fsPath

Parameters

Returns Promise<string>

Protected init

Returns void

mkdir

Parameters

Returns Promise<void>

open

Parameters

Returns Promise<number>

read

Parameters

Returns Promise<number>

readFile

Parameters

Returns Promise<Uint8Array>

readFileStream

Parameters

Returns ReadableStreamEvents<Uint8Array>

readdir

Parameters

Returns Promise<[string, FileType][]>

Protected reconnect

Returns void

rename

`Private` _capabilities

`Private` _readOnlyMessage

`Readonly` onDidChangeCapabilities

`Private` `Readonly` onDidChangeCapabilitiesEmitter

`Readonly` onDidChangeFile

`Private` `Readonly` onDidChangeFileEmitter

`Readonly` onDidChangeReadOnlyMessage

`Private` `Readonly` onDidChangeReadOnlyMessageEmitter

`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

`Protected` init

`Protected` reconnect

`Protected` setCapabilities

`Protected` setReadOnlyMessage