Class FileSystemProviderServer

Backend component.

JSON-RPC server exposing a wrapped file system provider remotely.

Hierarchy (view full)

FileSystemProviderServer
- BrowserOnlyFileSystemProviderServer

Implements

RemoteFileSystemServer

Index

Constructors

constructor

new FileSystemProviderServer(): FileSystemProviderServer
Returns FileSystemProviderServer

Properties

`Private` `Readonly` BUFFER_SIZE

BUFFER_SIZE: number = ...

`Protected` client

client: undefined | RemoteFileSystemClient

`Protected` `Readonly` provider

provider: FileSystemProvider & Partial<Disposable>

Wrapped file system provider.

`Protected` readFileStreamSeq

readFileStreamSeq: number = 0

`Protected` `Readonly` toDispose

toDispose: DisposableCollection = ...

`Protected` watchers

watchers: Map<number, Disposable> = ...

Mapping of watcherId to a disposable watcher handle.

Methods

access

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

close

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

copy

copy(source, target, opts): Promise<void>
Parameters
- source: string
- target: string
- opts: FileOverwriteOptions
Returns Promise<void>
Implementation of RemoteFileSystemServer.copy
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:500

delete

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

dispose

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

fsPath

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

getCapabilities

getCapabilities(): Promise<FileSystemProviderCapabilities>
Returns Promise<FileSystemProviderCapabilities>
Implementation of RemoteFileSystemServer.getCapabilities
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:409

getReadOnlyMessage

getReadOnlyMessage(): Promise<undefined | MarkdownString>
Returns Promise<undefined | MarkdownString>
Implementation of RemoteFileSystemServer.getReadOnlyMessage
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:413

`Protected` init

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

mkdir

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

open

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

read

read(fd, pos, length): Promise<{
bytes: Uint8Array;
bytesRead: number;
}>
Parameters
- fd: number
- pos: number
- length: number
Returns Promise<{
bytes: Uint8Array;
bytesRead: number;
}>
Implementation of RemoteFileSystemServer.read
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:453

readFile

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

readFileStream

readFileStream(resource, opts, token): Promise<number>
Parameters
- resource: string
- opts: FileReadStreamOptions
- token: CancellationToken
Returns Promise<number>
Implementation of RemoteFileSystemServer.readFileStream
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:533

readdir

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

rename

rename(source, target, opts): Promise<void>
Parameters
- source: string
- target: string
- opts: FileOverwriteOptions
Returns Promise<void>
Implementation of RemoteFileSystemServer.rename
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:496

setClient

setClient(client): void
Parameters
- client: undefined | RemoteFileSystemClient
Returns void
Implementation of RemoteFileSystemServer.setClient
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:367

stat

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

unwatch

unwatch(watcherId): Promise<void>
Parameters
- watcherId: number
Returns Promise<void>
Implementation of RemoteFileSystemServer.unwatch
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:523

updateFile

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

watch

watch(requestedWatcherId, resource, opts): Promise<void>
Parameters
- requestedWatcherId: number
- resource: string
- opts: WatchOptions
Returns Promise<void>
Implementation of RemoteFileSystemServer.watch
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:514

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 RemoteFileSystemServer.write
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:463

writeFile

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

Class FileSystemProviderServer

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FileSystemProviderServer

Properties

Private Readonly BUFFER_SIZE

Protected client

Protected Readonly provider

Protected readFileStreamSeq

Protected Readonly toDispose

Protected watchers

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>

getCapabilities

Returns Promise<FileSystemProviderCapabilities>

getReadOnlyMessage

Returns Promise<undefined | MarkdownString>

Protected init

Returns void

mkdir

Parameters

Returns Promise<void>

open

Parameters

Returns Promise<number>

read

Parameters

Returns Promise<{ bytes: Uint8Array; bytesRead: number; }>

readFile

Parameters

Returns Promise<Uint8Array>

readFileStream

Parameters

Returns Promise<number>

readdir

Parameters

Returns Promise<[string, FileType][]>

rename

Parameters

Returns Promise<void>

setClient

Parameters

Returns void

stat

Parameters

Returns Promise<Stat>

unwatch

Parameters

Returns Promise<void>

updateFile

Parameters

Returns Promise<FileUpdateResult>

watch

Parameters

Returns Promise<void>

write

Parameters

Returns Promise<number>

`Private` `Readonly` BUFFER_SIZE

`Protected` client

`Protected` `Readonly` provider

`Protected` readFileStreamSeq

`Protected` `Readonly` toDispose

`Protected` watchers

`Protected` init

Returns Promise<{
bytes: Uint8Array;
bytesRead: number;
}>