Class DelegatingFileSystemProvider

Hierarchy

DelegatingFileSystemProvider

Implements

Required<FileSystemProvider>
Disposable

Constructors

constructor

new DelegatingFileSystemProvider(delegate: FileSystemProvider, options: DelegatingFileSystemProvider.Options, toDispose?: DisposableCollection): DelegatingFileSystemProvider

- Defined in packages/filesystem/src/common/delegating-file-system-provider.ts:37
Parameters
- delegate: FileSystemProvider
- options: DelegatingFileSystemProvider.Options
- toDispose: DisposableCollection = ...
Returns DelegatingFileSystemProvider

Properties

Protected Readonly delegate

delegate: FileSystemProvider

Readonly onDidChangeFile

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

Private Readonly onDidChangeFileEmitter

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

Readonly onFileWatchError

onFileWatchError: Event<void> = ...

Private Readonly onFileWatchErrorEmitter

onFileWatchErrorEmitter: Emitter<void> = ...

Protected Readonly options

options: DelegatingFileSystemProvider.Options

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Accessors

capabilities

get capabilities(): FileSystemProviderCapabilities

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

onDidChangeCapabilities

get onDidChangeCapabilities(): Event<void>

Implementation of Required.onDidChangeCapabilities
- Defined in packages/filesystem/src/common/delegating-file-system-provider.ts:56
Returns Event<void>

Methods

access

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

Implementation of Required.access
- Defined in packages/filesystem/src/common/delegating-file-system-provider.ts:68
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/delegating-file-system-provider.ts:129
Parameters
- fd: number
Returns Promise<void>

copy

copy(from: URI, to: URI, opts: FileOverwriteOptions): Promise<void>

Implementation of Required.copy
- Defined in packages/filesystem/src/common/delegating-file-system-provider.ts:90
Parameters
- from: URI
- to: URI
- opts: FileOverwriteOptions
Returns Promise<void>

delete

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

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

dispose

dispose(): void

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

fromUnderlyingResource

fromUnderlyingResource(resource: URI): undefined | URI

- Defined in packages/filesystem/src/common/delegating-file-system-provider.ts:198
Converts from an underlying fs provider resource format.
For example converting file resources under a user home to user-storage resource:
- file://home/.theia/settings.json => user-storage:/user/settings.json
- file://documents/some-document.txt => undefined
Parameters
- resource: URI
Returns undefined | URI

fsPath

fsPath(resource: URI): Promise<string>

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

Protected handleFileChanges

handleFileChanges(changes: readonly FileChange[]): void

- Defined in packages/filesystem/src/common/delegating-file-system-provider.ts:161
Parameters
- changes: readonly FileChange[]
Returns void

mkdir

mkdir(resource: URI): Promise<void>

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

open

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

Implementation of Required.open
- Defined in packages/filesystem/src/common/delegating-file-system-provider.ts:122
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/delegating-file-system-provider.ts:136
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/delegating-file-system-provider.ts:97
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/delegating-file-system-provider.ts:104
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/delegating-file-system-provider.ts:111
Parameters
- resource: URI
Returns Promise<[string, FileType][]>

rename

rename(from: URI, to: URI, opts: FileOverwriteOptions): Promise<void>

Implementation of Required.rename
- Defined in packages/filesystem/src/common/delegating-file-system-provider.ts:86
Parameters
- from: URI
- to: URI
- opts: FileOverwriteOptions
Returns Promise<void>

stat

stat(resource: URI): Promise<Stat>

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

toUnderlyingResource

toUnderlyingResource(resource: URI): URI

- Defined in packages/filesystem/src/common/delegating-file-system-provider.ts:183
Converts to an underlying fs provider resource format.

For example converting user-storage resources to file resources under a user home: user-storage:/user/settings.json => file://home/.theia/settings.json

Parameters
- resource: URI
Returns URI

updateFile

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

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

watch

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

Implementation of Required.watch
- Defined in packages/filesystem/src/common/delegating-file-system-provider.ts:60
Parameters
- resource: URI
- opts: 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/delegating-file-system-provider.ts:143
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/delegating-file-system-provider.ts:115
Parameters
- resource: URI
- content: Uint8Array
- opts: FileWriteOptions
Returns Promise<void>