Interface PlatformIO

interface PlatformIO {
    network?: NetworkIO;
    access(path: string, mode: number): void;
    chmod(path: string, mode: number): void;
    chown(path: string, uid: number, gid: number): void;
    clockGettime(clockId: number): { nsec: number; sec: number };
    close(handle: number): number;
    closedir(handle: number): void;
    fchmod(handle: number, mode: number): void;
    fchown(handle: number, uid: number, gid: number): void;
    fileHandleIdentity?(
        handle: number,
        dev: bigint,
        ino: bigint,
    ): string | null;
    fileIdentity?(path: string, dev: bigint, ino: bigint): string | null;
    fpathconf(handle: number, name: number): PathconfValue;
    fstat(handle: number): StatResult;
    fsync(handle: number): void;
    ftruncate(handle: number, length: number): void;
    lchown(path: string, uid: number, gid: number): void;
    link(existingPath: string, newPath: string): void;
    lstat(path: string): StatResult;
    mkdir(path: string, mode: number): void;
    nanosleep(sec: number, nsec: number): void;
    open(path: string, flags: number, mode: number): number;
    opendir(path: string): number;
    pathconf(path: string, name: number): PathconfValue;
    preparePath?(path: string): Promise<boolean>;
    read(
        handle: number,
        buffer: Uint8Array,
        offset: number | null,
        length: number,
    ): number;
    readdir(handle: number): { ino: number; name: string; type: number } | null;
    readlink(path: string): string;
    rename(oldPath: string, newPath: string): void;
    rmdir(path: string): void;
    seek(handle: number, offset: number, whence: number): number;
    stat(path: string): StatResult;
    statfs(path: string): StatfsResult;
    symlink(target: string, path: string): void;
    unlink(path: string): void;
    utimensat(
        path: string,
        atimeSec: number,
        atimeNsec: number,
        mtimeSec: number,
        mtimeNsec: number,
    ): void;
    waitpid?(pid: number, options: number): { pid: number; status: number };
    write(
        handle: number,
        buffer: Uint8Array,
        offset: number | null,
        length: number,
    ): number;
}

Implemented by

Properties

`Optional`network

network?: NetworkIO

Methods

access

access(path: string, mode: number): void
Parameters
- path: string
- mode: number
Returns void
- Defined in types.ts:107

chmod

chmod(path: string, mode: number): void
Parameters
- path: string
- mode: number
Returns void
- Defined in types.ts:104

chown

chown(path: string, uid: number, gid: number): void
Parameters
- path: string
- uid: number
- gid: number
Returns void
- Defined in types.ts:105

clockGettime

clockGettime(clockId: number): { nsec: number; sec: number }
Parameters
- clockId: number
Returns { nsec: number; sec: number }
- Defined in types.ts:128

close

close(handle: number): number
Parameters
- handle: number
Returns number
- Defined in types.ts:55

closedir

closedir(handle: number): void
Parameters
- handle: number
Returns void
- Defined in types.ts:119

fchmod

fchmod(handle: number, mode: number): void
Parameters
- handle: number
- mode: number
Returns void
- Defined in types.ts:124

fchown

fchown(handle: number, uid: number, gid: number): void
Parameters
- handle: number
- uid: number
- gid: number
Returns void
- Defined in types.ts:125

`Optional`fileHandleIdentity

fileHandleIdentity?(handle: number, dev: bigint, ino: bigint): string | null
Qualify an inode through an already-open file handle.

Unlike fileIdentity, this must not resolve the remembered pathname: an open file remains a valid mmap backing after that name is unlinked or renamed. Return null when the backend cannot promise stable identity.
Parameters
- handle: number
- dev: bigint
- ino: bigint
Returns string | null
- Defined in types.ts:90

`Optional`fileIdentity

fileIdentity?(path: string, dev: bigint, ino: bigint): string | null
Qualify a filesystem-reported inode within this PlatformIO instance.

The path is used only to select the owning mount/backend; callers may pass the remembered path of an unlinked or renamed open file. Equal identities must name the same underlying file object, including through hard links. Return null when the backend cannot promise stable object identity (for example, a backend that reports no inode number).
Parameters
- path: string
- dev: bigint
- ino: bigint
Returns string | null
- Defined in types.ts:81

fpathconf

fpathconf(handle: number, name: number): PathconfValue
Parameters
- handle: number
- name: number
Returns PathconfValue
- Defined in types.ts:70

fstat

fstat(handle: number): StatResult
Parameters
- handle: number
Returns StatResult
- Defined in types.ts:69

fsync

fsync(handle: number): void
Parameters
- handle: number
Returns void
- Defined in types.ts:123

ftruncate

ftruncate(handle: number, length: number): void
Parameters
- handle: number
- length: number
Returns void
- Defined in types.ts:122

lchown

lchown(path: string, uid: number, gid: number): void
Parameters
- path: string
- uid: number
- gid: number
Returns void
- Defined in types.ts:106

link

link(existingPath: string, newPath: string): void
Parameters
- existingPath: string
- newPath: string
Returns void
- Defined in types.ts:101

lstat

lstat(path: string): StatResult
Parameters
- path: string
Returns StatResult
- Defined in types.ts:94

mkdir

mkdir(path: string, mode: number): void
Parameters
- path: string
- mode: number
Returns void
- Defined in types.ts:97

nanosleep

nanosleep(sec: number, nsec: number): void
Parameters
- sec: number
- nsec: number
Returns void
- Defined in types.ts:129

open

open(path: string, flags: number, mode: number): number
Parameters
- path: string
- flags: number
- mode: number
Returns number
- Defined in types.ts:54

opendir

opendir(path: string): number
Parameters
- path: string
Returns number
- Defined in types.ts:111

pathconf

pathconf(path: string, name: number): PathconfValue
Parameters
- path: string
- name: number
Returns PathconfValue
- Defined in types.ts:96

`Optional`preparePath

preparePath?(path: string): Promise<boolean>
Resolve and materialize deferred backing for a path before a synchronous open/read consumer enters the filesystem. Implementations without lazy backing may omit this hook.
Parameters
- path: string
Returns Promise<boolean>
- Defined in types.ts:53

read

read(
    handle: number,
    buffer: Uint8Array,
    offset: number | null,
    length: number,
): number
Parameters
- handle: number
- buffer: Uint8Array
- offset: number | null
- length: number
Returns number
- Defined in types.ts:56

readdir

readdir(handle: number): { ino: number; name: string; type: number } | null
Return and consume the next entry. If this throws, the iterator must stay on that entry so the caller can retry without a directory-position gap.
Parameters
- handle: number
Returns { ino: number; name: string; type: number } | null
- Defined in types.ts:116

readlink

readlink(path: string): string
Parameters
- path: string
Returns string
- Defined in types.ts:103

rename

rename(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
- Defined in types.ts:100

rmdir

rmdir(path: string): void
Parameters
- path: string
Returns void
- Defined in types.ts:98

seek

seek(handle: number, offset: number, whence: number): number
Parameters
- handle: number
- offset: number
- whence: number
Returns number
- Defined in types.ts:68

stat

stat(path: string): StatResult
Parameters
- path: string
Returns StatResult
- Defined in types.ts:93

statfs

statfs(path: string): StatfsResult
Parameters
- path: string
Returns StatfsResult
- Defined in types.ts:95

symlink

symlink(target: string, path: string): void
Parameters
- target: string
- path: string
Returns void
- Defined in types.ts:102

unlink

unlink(path: string): void
Parameters
- path: string
Returns void
- Defined in types.ts:99

utimensat

utimensat(
    path: string,
    atimeSec: number,
    atimeNsec: number,
    mtimeSec: number,
    mtimeNsec: number,
): void
Parameters
- path: string
- atimeSec: number
- atimeNsec: number
- mtimeSec: number
- mtimeNsec: number
Returns void
- Defined in types.ts:108

`Optional`waitpid

waitpid?(pid: number, options: number): { pid: number; status: number }
Parameters
- pid: number
- options: number
Returns { pid: number; status: number }
- Defined in types.ts:132

write

write(
    handle: number,
    buffer: Uint8Array,
    offset: number | null,
    length: number,
): number
Parameters
- handle: number
- buffer: Uint8Array
- offset: number | null
- length: number
Returns number
- Defined in types.ts:62

Interface PlatformIO

Implemented by

Index

Properties

Methods

Properties

Optionalnetwork

Methods

access

Parameters

Returns void

chmod

Parameters

Returns void

chown

Parameters

Returns void

clockGettime

Parameters

Returns { nsec: number; sec: number }

close

Parameters

Returns number

closedir

Parameters

Returns void

fchmod

Parameters

Returns void

fchown

Parameters

Returns void

OptionalfileHandleIdentity

Parameters

Returns string | null

OptionalfileIdentity

Parameters

Returns string | null

fpathconf

Parameters

Returns PathconfValue

fstat

Parameters

Returns StatResult

fsync

Parameters

Returns void

ftruncate

Parameters

Returns void

lchown

Parameters

Returns void

link

Parameters

Returns void

lstat

Parameters

Returns StatResult

mkdir

Parameters

Returns void

nanosleep

Parameters

Returns void

open

Parameters

Returns number

opendir

Parameters

Returns number

pathconf

Parameters

Returns PathconfValue

OptionalpreparePath

Parameters

Returns Promise<boolean>

read

Parameters

Returns number

`Optional`network

`Optional`fileHandleIdentity

`Optional`fileIdentity

`Optional`preparePath

`Optional`waitpid