Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
plugin/file-system-ext-impl
FileSystemExtImpl
Class FileSystemExtImpl
Implements
FileSystemExt
Index
Constructors
constructor
Properties
file
System
on
Will
Register
File
System
Provider
Methods
$accept
Provider
Infos
$close
$copy
$delete
$mkdir
$open
$read
$readdir
$read
File
$rename
$stat
$unwatch
$watch
$write
$write
File
dispose
register
File
System
Provider
Constructors
constructor
new
FileSystemExtImpl
(
rpc
:
RPCProtocol
)
:
FileSystemExtImpl
Parameters
rpc
:
RPCProtocol
Returns
FileSystemExtImpl
Properties
Readonly
file
System
fileSystem
:
ConsumerFileSystem
Readonly
on
Will
Register
File
System
Provider
onWillRegisterFileSystemProvider
:
Event
<
FsLinkProvider
>
= ...
Methods
$accept
Provider
Infos
$acceptProviderInfos
(
scheme
:
string
,
capabilities
?:
FileSystemProviderCapabilities
,
)
:
void
Parameters
scheme
:
string
Optional
capabilities
:
FileSystemProviderCapabilities
Returns
void
$close
$close
(
handle
:
number
,
fd
:
number
)
:
Promise
<
void
>
Parameters
handle
:
number
fd
:
number
Returns
Promise
<
void
>
$copy
$copy
(
handle
:
number
,
oldUri
:
UriComponents
,
newUri
:
UriComponents
,
opts
:
FileOverwriteOptions
,
)
:
Promise
<
void
>
Parameters
handle
:
number
oldUri
:
UriComponents
newUri
:
UriComponents
opts
:
FileOverwriteOptions
Returns
Promise
<
void
>
$delete
$delete
(
handle
:
number
,
resource
:
UriComponents
,
opts
:
FileDeleteOptions
,
)
:
Promise
<
void
>
Parameters
handle
:
number
resource
:
UriComponents
opts
:
FileDeleteOptions
Returns
Promise
<
void
>
$mkdir
$mkdir
(
handle
:
number
,
resource
:
UriComponents
)
:
Promise
<
void
>
Parameters
handle
:
number
resource
:
UriComponents
Returns
Promise
<
void
>
$open
$open
(
handle
:
number
,
resource
:
UriComponents
,
opts
:
FileOpenOptions
,
)
:
Promise
<
number
>
Parameters
handle
:
number
resource
:
UriComponents
opts
:
FileOpenOptions
Returns
Promise
<
number
>
$read
$read
(
handle
:
number
,
fd
:
number
,
pos
:
number
,
length
:
number
,
)
:
Promise
<
BinaryBuffer
>
Parameters
handle
:
number
fd
:
number
pos
:
number
length
:
number
Returns
Promise
<
BinaryBuffer
>
$readdir
$readdir
(
handle
:
number
,
resource
:
UriComponents
)
:
Promise
<
[
string
,
FileType
]
[]
>
Parameters
handle
:
number
resource
:
UriComponents
Returns
Promise
<
[
string
,
FileType
]
[]
>
$read
File
$readFile
(
handle
:
number
,
resource
:
UriComponents
)
:
Promise
<
BinaryBuffer
>
Parameters
handle
:
number
resource
:
UriComponents
Returns
Promise
<
BinaryBuffer
>
$rename
$rename
(
handle
:
number
,
oldUri
:
UriComponents
,
newUri
:
UriComponents
,
opts
:
FileOverwriteOptions
,
)
:
Promise
<
void
>
Parameters
handle
:
number
oldUri
:
UriComponents
newUri
:
UriComponents
opts
:
FileOverwriteOptions
Returns
Promise
<
void
>
$stat
$stat
(
handle
:
number
,
resource
:
UriComponents
)
:
Promise
<
Stat
>
Parameters
handle
:
number
resource
:
UriComponents
Returns
Promise
<
Stat
>
$unwatch
$unwatch
(
_handle
:
number
,
session
:
number
)
:
void
Parameters
_handle
:
number
session
:
number
Returns
void
$watch
$watch
(
handle
:
number
,
session
:
number
,
resource
:
UriComponents
,
opts
:
WatchOptions
,
)
:
void
Parameters
handle
:
number
session
:
number
resource
:
UriComponents
opts
:
WatchOptions
Returns
void
$write
$write
(
handle
:
number
,
fd
:
number
,
pos
:
number
,
data
:
BinaryBuffer
,
)
:
Promise
<
number
>
Parameters
handle
:
number
fd
:
number
pos
:
number
data
:
BinaryBuffer
Returns
Promise
<
number
>
$write
File
$writeFile
(
handle
:
number
,
resource
:
UriComponents
,
content
:
BinaryBuffer
,
opts
:
FileWriteOptions
,
)
:
Promise
<
void
>
Parameters
handle
:
number
resource
:
UriComponents
content
:
BinaryBuffer
opts
:
FileWriteOptions
Returns
Promise
<
void
>
dispose
dispose
()
:
void
Returns
void
register
File
System
Provider
registerFileSystemProvider
(
scheme
:
string
,
provider
:
FileSystemProvider
,
options
?:
{
isCaseSensitive
?:
boolean
;
isReadonly
?:
boolean
|
MarkdownString
;
}
,
)
:
{
dispose
:
()
=>
void
}
Parameters
scheme
:
string
provider
:
FileSystemProvider
options
:
{
isCaseSensitive
?:
boolean
;
isReadonly
?:
boolean
|
MarkdownString
}
= {}
Returns
{
dispose
:
()
=>
void
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
file
System
on
Will
Register
File
System
Provider
Methods
$accept
Provider
Infos
$close
$copy
$delete
$mkdir
$open
$read
$readdir
$read
File
$rename
$stat
$unwatch
$watch
$write
$write
File
dispose
register
File
System
Provider
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...