ngs - v1.0.5

njs/fs

Types

Dirent

</> 
pub type Dirent

Encoding

</> 
pub type Encoding {
  Utf8
  Buffer
  Hex
  Base64
  Base64Url
}

Constructors 

  • Utf8
  • Buffer
  • Hex
  • Base64
  • Base64Url

FileHandle

</> 
pub type FileHandle

FileHandleReadResult

</> 
pub type FileHandleReadResult {
  FileHandleReadResult(bytes_read: Int, buffer: buffer.Buffer)
}

Constructors

Flag

</> 
pub type Flag {
  A
  Ax
  Aplus
  Axplus
  As
  Asx
  Asplus
  Asxplus
  R
  Rs
  Rplus
  Rsplus
  Rx
  Rsx
  Rxplus
  Rsxplus
  W
  Ws
  Wx
  Wsx
  Wplus
  Wsplus
  Wxplus
  Wsxplus
}

Constructors 

  • A
  • Ax
  • Aplus
  • Axplus
  • As
  • Asx
  • Asplus
  • Asxplus
  • R
  • Rs
  • Rplus
  • Rsplus
  • Rx
  • Rsx
  • Rxplus
  • Rsxplus
  • W
  • Ws
  • Wx
  • Wsx
  • Wplus
  • Wsplus
  • Wxplus
  • Wsxplus

MkdirOptions

</> 
pub type MkdirOptions {
  MkdirOptions(mode: Int)
}

Constructors 

  • MkdirOptions(mode: Int)

OpenOptions

</> 
pub type OpenOptions {
  OpenOptions(mode: Int)
}

Constructors 

  • OpenOptions(mode: Int)

ReadFileOptions

</> 
pub type ReadFileOptions {
  ReadFileOptions(encoding: Encoding, flag: Flag)
}

Constructors

ReadOptions

</> 
pub type ReadOptions {
  ReadOptions(encoding: Encoding)
}

Constructors

ReaddirOptions

</> 
pub type ReaddirOptions {
  ReaddirOptions(encoding: Encoding, with_file_types: Bool)
}

Constructors 

  • ReaddirOptions(encoding: Encoding, with_file_types: Bool)

StatOptions

</> 
pub type StatOptions {
  StatOptions(throw_if_no_entry: Bool)
}

Constructors 

  • StatOptions(throw_if_no_entry: Bool)

Stats

</> 
pub type Stats

WriteFileOptions

</> 
pub type WriteFileOptions {
  WriteFileOptions(mode: Int, flag: Flag)
}

Constructors 

  • WriteFileOptions(mode: Int, flag: Flag)

Values

access_sync

</> 
pub fn access_sync(path: String, mode: Int) -> Nil

append_file_sync

</> 
pub fn append_file_sync(
  filename: String,
  data: a,
  options: o,
) -> Nil

close_sync

</> 
pub fn close_sync(fd: Int) -> Nil

constants_f_ok

</> 
pub fn constants_f_ok() -> Int

constants_r_ok

</> 
pub fn constants_r_ok() -> Int

constants_w_ok

</> 
pub fn constants_w_ok() -> Int

constants_x_ok

</> 
pub fn constants_x_ok() -> Int

dirent_is_block_device

</> 
pub fn dirent_is_block_device(dirent: Dirent) -> Bool

dirent_is_character_device

</> 
pub fn dirent_is_character_device(dirent: Dirent) -> Bool

dirent_is_directory

</> 
pub fn dirent_is_directory(dirent: Dirent) -> Bool

dirent_is_fifo

</> 
pub fn dirent_is_fifo(dirent: Dirent) -> Bool

dirent_is_file

</> 
pub fn dirent_is_file(dirent: Dirent) -> Bool

dirent_is_socket

</> 
pub fn dirent_is_socket(dirent: Dirent) -> Bool
</> 
pub fn dirent_is_symbolic_link(dirent: Dirent) -> Bool

dirent_name

</> 
pub fn dirent_name(dirent: Dirent) -> String

exists_sync

</> 
pub fn exists_sync(path: String) -> Bool

file_handle_close

</> 
pub fn file_handle_close(
  handle: FileHandle,
) -> promise.Promise(Nil)

file_handle_fd

</> 
pub fn file_handle_fd(handle: FileHandle) -> Int

file_handle_read

</> 
pub fn file_handle_read(
  handle: FileHandle,
  buffer: buffer.Buffer,
  offset: Int,
  length: Int,
  position: a,
) -> promise.Promise(FileHandleReadResult)

file_handle_stat

</> 
pub fn file_handle_stat(
  handle: FileHandle,
) -> promise.Promise(Stats)

file_handle_write_buffer

</> 
pub fn file_handle_write_buffer(
  handle: FileHandle,
  buffer: buffer.Buffer,
  offset: Int,
  length: Int,
  position: a,
) -> promise.Promise(FileHandleReadResult)

file_handle_write_string

</> 
pub fn file_handle_write_string(
  handle: FileHandle,
  string: String,
  position: a,
  encoding: String,
) -> promise.Promise(FileHandleReadResult)

fstat_sync

</> 
pub fn fstat_sync(fd: Int) -> Stats

lstat_sync

</> 
pub fn lstat_sync(path: String, options: o) -> Stats

mkdir_sync

</> 
pub fn mkdir_sync(path: String, options: o) -> Nil

open_sync

</> 
pub fn open_sync(path: String, flags: String, mode: Int) -> Int

promises_open

</> 
pub fn promises_open(
  path: String,
  flags: String,
  mode: Int,
) -> promise.Promise(FileHandle)

read_dir_sync

</> 
pub fn read_dir_sync(path: String, options: o) -> array.Array(a)

read_file_sync

</> 
pub fn read_file_sync(filename: String, options: o) -> a
</> 
pub fn read_link_sync(path: String, encoding: String) -> a

read_sync

</> 
pub fn read_sync(
  fd: Int,
  buffer: buffer.Buffer,
  offset: Int,
  length: Int,
  position: a,
) -> Int

real_path_sync

</> 
pub fn real_path_sync(path: String, encoding: String) -> String

rename_sync

</> 
pub fn rename_sync(old_path: String, new_path: String) -> Nil

rmdir_sync

</> 
pub fn rmdir_sync(path: String) -> Nil

stat_sync

</> 
pub fn stat_sync(path: String, options: o) -> Stats

stats_atime

</> 
pub fn stats_atime(stats: Stats) -> String

stats_atime_ms

</> 
pub fn stats_atime_ms(stats: Stats) -> Int

stats_birthtime

</> 
pub fn stats_birthtime(stats: Stats) -> String

stats_birthtime_ms

</> 
pub fn stats_birthtime_ms(stats: Stats) -> Int

stats_blksize

</> 
pub fn stats_blksize(stats: Stats) -> Int

stats_blocks

</> 
pub fn stats_blocks(stats: Stats) -> Int

stats_ctime

</> 
pub fn stats_ctime(stats: Stats) -> String

stats_ctime_ms

</> 
pub fn stats_ctime_ms(stats: Stats) -> Int

stats_dev

</> 
pub fn stats_dev(stats: Stats) -> Int

stats_gid

</> 
pub fn stats_gid(stats: Stats) -> Int

stats_ino

</> 
pub fn stats_ino(stats: Stats) -> Int

stats_is_block_device

</> 
pub fn stats_is_block_device(stats: Stats) -> Bool

stats_is_directory

</> 
pub fn stats_is_directory(stats: Stats) -> Bool

stats_is_fifo

</> 
pub fn stats_is_fifo(stats: Stats) -> Bool

stats_is_file

</> 
pub fn stats_is_file(stats: Stats) -> Bool

stats_is_socket

</> 
pub fn stats_is_socket(stats: Stats) -> Bool
</> 
pub fn stats_is_symbolic_link(stats: Stats) -> Bool

stats_mode

</> 
pub fn stats_mode(stats: Stats) -> Int

stats_mtime

</> 
pub fn stats_mtime(stats: Stats) -> String

stats_mtime_ms

</> 
pub fn stats_mtime_ms(stats: Stats) -> Int
</> 
pub fn stats_nlink(stats: Stats) -> Int

stats_rdev

</> 
pub fn stats_rdev(stats: Stats) -> Int

stats_size

</> 
pub fn stats_size(stats: Stats) -> Int

stats_uid

</> 
pub fn stats_uid(stats: Stats) -> Int
</> 
pub fn symlink_sync(target: String, path: String) -> Nil
</> 
pub fn unlink_sync(path: String) -> Nil

write_file_sync

</> 
pub fn write_file_sync(
  filename: String,
  data: a,
  options: o,
) -> Nil

write_sync_buffer

</> 
pub fn write_sync_buffer(
  fd: Int,
  buffer: buffer.Buffer,
  offset: Int,
  length: Int,
  position: a,
) -> Int

write_sync_string

</> 
pub fn write_sync_string(
  fd: Int,
  string: String,
  position: a,
  encoding: String,
) -> Int
✨ Search Document