Class BrowserOnlyFileSystemProviderServer

Backend component.

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

Hierarchy (View Summary)

FileSystemProviderServer
- BrowserOnlyFileSystemProviderServer

Index

Constructors

constructor

new BrowserOnlyFileSystemProviderServer(): BrowserOnlyFileSystemProviderServer
Returns BrowserOnlyFileSystemProviderServer
Inherited from FileSystemProviderServer.constructor

Properties

`Protected`client

client: undefined | RemoteFileSystemClient

onDidCloseConnection

onDidCloseConnection: Event<any> = Event.None

onDidOpenConnection

onDidOpenConnection: Event<any> = Event.None

needed because users expect implicitly the RemoteFileSystemServer to be a RemoteFileSystemProxyFactory

`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>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.delete
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:485

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.fsPath
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:433

mkdir

mkdir(resource: string): Promise<void>
Parameters
- resource: string
Returns Promise<void>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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 }>
Inherited from FileSystemProviderServer.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][]>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.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>
Inherited from FileSystemProviderServer.writeFile
- Defined in packages/filesystem/src/common/remote-file-system-provider.ts:478

Class BrowserOnlyFileSystemProviderServer

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BrowserOnlyFileSystemProviderServer

Properties

Protectedclient

onDidCloseConnection

onDidOpenConnection

Protected Readonlyprovider

Protected ReadonlytoDispose

Protectedwatchers

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>

Protectedinit

Returns void

mkdir

Parameters

Returns Promise<void>

open

Parameters

Returns Promise<number>

read

Parameters

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

readdir

Parameters

Returns Promise<[string, FileType][]>

readFile

Parameters

Returns Promise<Uint8Array>

readFileStream

Parameters

Returns Promise<void>

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>

writeFile

`Protected`client

`Protected` `Readonly`provider

`Protected` `Readonly`toDispose

`Protected`watchers

`Protected`init