Class FileSystemProviderServer

Backend component.

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

Hierarchy (View Summary)

FileSystemProviderServer
- BrowserOnlyFileSystemProviderServer

Implements

RemoteFileSystemServer

Index

Constructors

Properties

client provider toDispose watchers

Methods

access close copy delete dispose fsPath getCapabilities getReadOnlyMessage init mkdir open read readdir readFile readFileStream rename setClient stat unwatch updateFile watch write writeFile

Constructors

constructor

new FileSystemProviderServer(): FileSystemProviderServer
Returns FileSystemProviderServer

Properties

`Protected`client

client: undefined | RemoteFileSystemClient

`Protected` `Readonly`provider

provider: FileSystemProvider & Partial<Disposable>

Wrapped file system provider.

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Protected`watchers

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

Mapping of watcherId to a disposable watcher handle.

Methods

access

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

close

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

copy

copy(source: string, target: string, opts: FileOverwriteOptions): 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:501

delete

delete(resource: string, opts: FileDeleteOptions): 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:485

dispose

dispose(): void
Dispose this object.

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

fsPath

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

getCapabilities

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

getReadOnlyMessage

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

`Protected`init

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

mkdir

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

open

open(resource: string, opts: FileOpenOptions): 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:440

read

read(
    fd: number,
    pos: number,
    length: number,
): 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:454

readdir

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

readFile

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

readFileStream

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

rename

rename(
    source: string,
    target: string,
    opts: FileOverwriteOptions,
): 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:497

setClient

setClient(client: undefined | RemoteFileSystemClient): void
If this server is a proxy to a remote server then a client is used as a local object to handle RPC messages from the remote server.
Parameters
- client: undefined | RemoteFileSystemClient
Returns void
Implementation of RemoteFileSystemServer.setClient
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:368

stat

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

unwatch

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

updateFile

updateFile(
    resource: string,
    changes: TextDocumentContentChangeEvent[],
    opts: FileUpdateOptions,
): 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:508

watch

watch(
    requestedWatcherId: number,
    resource: string,
    opts: WatchOptions,
): 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:515

write

write(
    fd: number,
    pos: number,
    data: Uint8Array,
    offset: number,
    length: number,
): 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:464

writeFile

writeFile(
    resource: string,
    content: Uint8Array,
    opts: FileWriteOptions,
): 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:478