Skip to content

filesystem.md

Latest commit

 

History

History
255 lines (134 loc) · 2.58 KB

filesystem.md

File metadata and controls

255 lines (134 loc) · 2.58 KB

FileSystem

Documentation for the FileSystem API.

Most of the code is either directly copied from or based on: https://github.com/nkolban/duktape-esp32.git under the Apache 2.0 license.

Methods

close(fd)

Close file descriptor.

  • fd

    type: int

    file descriptor

fsSizeTotal()

Get total size of the flash filesystem.

Returns: size in bytes of the filesystem

fsSizeUsed()

Get used number of bytes of the flash filesystem.

Returns: bytes used of the filesystem

fstat(fd)

Stat a file descriptor but inly return size.

  • fd

    type: int

    file descriptor

Returns: {'size': file_size}

listDir()

List files in the filesystem.

Returns: array of strings (e.g., ['filename', 'otherfilename'])

open(path,flags)

Open file.

  • path

    type: string

    file path

  • flags

    type: string

    flags ('r', 'w', 'a', ...)

Returns: file descriptor (or -1 for error)

read(fd,buffer,bufferOffset,maxRead)

Read from a file descriptor.

  • fd

    type: int

    file descriptor

  • buffer

    type: Plain Buffer

    buffer

  • bufferOffset

    type: uint

    offset into the buffer

  • maxRead

    type: uint

    max num bytes to read

Returns: number of bytes read

seek(fd,offset,whence)

seek to a specific offset in the file. This implements lseek(2)

  • fd

    type: uint

    file descriptor

  • offset

    type: uint

    offset

  • whence

    type: int

    whence 0 = SET, 1 = CUR, 2 = END

Returns: current position in the file

FileSystem.seek(fp, 0, 2); // seek to end of file

stat(path)

Stat a file path but inly return size.

  • path

    type: string

    filepath

Returns: {'size': file_size}

unlink(path)

Unlink (delete) file.

  • path

    type: int

    filepath

write(fd,buffer,bufferOffset,length)

Write to file descriptor.

  • fd

    type: uint

    file descriptor

  • buffer

    type: Plain Buffer

    data

  • bufferOffset

    type: uint

    offset in the buffer (optional)

  • length

    type: uint

    length (optional)

Returns: num bytes written

write (fd,string)

Write string to file descriptor.

  • fd

    type: uint

    file descriptor

  • string

    type: string

    data

Returns: num bytes written