weapp - v1.0.8

wechat/filesystem

filesystem module provides file system API bindings details in wechat document

Types

Stats

</>

Stats type for file statistics

pub type Stats

Values

access

</> 
pub fn access(
  fsm: object.JsObject,
  path p: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.access Check if a file exists

access_sync

</> 
pub fn access_sync(fsm: object.JsObject, path p: String) -> Nil

FileSystemManager.accessSync Synchronously check if a file exists

append_file

</> 
pub fn append_file(
  fsm: object.JsObject,
  path p: String,
  data d: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.appendFile Append content to a file

append_file_sync

</> 
pub fn append_file_sync(
  fsm: object.JsObject,
  path p: String,
  data d: object.JsObject,
) -> Nil

FileSystemManager.appendFileSync Synchronously append content to a file

close

</> 
pub fn close(
  fsm: object.JsObject,
  fd: Float,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.close Close a file

close_sync

</> 
pub fn close_sync(fsm: object.JsObject, fd: Float) -> Nil

FileSystemManager.closeSync Synchronously close a file

copy_file

</> 
pub fn copy_file(
  fsm: object.JsObject,
  src s: String,
  dest d: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.copyFile Copy a file

copy_file_sync

</> 
pub fn copy_file_sync(
  fsm: object.JsObject,
  src s: String,
  dest d: String,
) -> Nil

FileSystemManager.copyFileSync Synchronously copy a file

fstat

</> 
pub fn fstat(
  fsm: object.JsObject,
  fd: Float,
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.fstat Get file statistics by file descriptor

fstat_sync

</> 
pub fn fstat_sync(
  fsm: object.JsObject,
  fd: Float,
  options o: object.JsObject,
) -> object.JsObject

FileSystemManager.fstatSync Synchronously get file statistics by file descriptor

ftruncate

</> 
pub fn ftruncate(
  fsm: object.JsObject,
  fd: Float,
  len: Int,
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.ftruncate Truncate a file by file descriptor

ftruncate_sync

</> 
pub fn ftruncate_sync(
  fsm: object.JsObject,
  fd: Float,
  len: Int,
  options o: object.JsObject,
) -> Nil

FileSystemManager.ftruncateSync Synchronously truncate a file by file descriptor

get_file_info

</> 
pub fn get_file_info(
  fsm: object.JsObject,
  path p: String,
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.getFileInfo Get file information

get_file_system_manager

</> 
pub fn get_file_system_manager() -> object.JsObject

wx.getFileSystemManager Get the file system manager object

get_saved_file_list

</> 
pub fn get_saved_file_list(
  fsm: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.getSavedFileList Get list of saved files

mkdir

</> 
pub fn mkdir(
  fsm: object.JsObject,
  dir d: String,
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.mkdir Create a directory

mkdir_sync

</> 
pub fn mkdir_sync(
  fsm: object.JsObject,
  dir d: String,
  options o: object.JsObject,
) -> Nil

FileSystemManager.mkdirSync Synchronously create a directory

open

</> 
pub fn open(
  fsm: object.JsObject,
  path p: String,
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.open Open a file

open_sync

</> 
pub fn open_sync(
  fsm: object.JsObject,
  path p: String,
  options o: object.JsObject,
) -> Float

FileSystemManager.openSync Synchronously open a file

read

</> 
pub fn read(
  fsm: object.JsObject,
  fd: Float,
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.read Read from a file

read_compressed_file

</> 
pub fn read_compressed_file(
  fsm: object.JsObject,
  path p: String,
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.readCompressedFile Read a compressed file

read_compressed_file_sync

</> 
pub fn read_compressed_file_sync(
  fsm: object.JsObject,
  path p: String,
  options o: object.JsObject,
) -> object.JsObject

FileSystemManager.readCompressedFileSync Synchronously read a compressed file

read_file

</> 
pub fn read_file(
  fsm: object.JsObject,
  path p: String,
  encoding e: String,
  position pos: Int,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.readFile Read a file

read_file_sync

</> 
pub fn read_file_sync(
  fsm: object.JsObject,
  path p: String,
  encoding e: String,
  position pos: Int,
) -> object.JsObject

FileSystemManager.readFileSync Synchronously read a file

read_sync

</> 
pub fn read_sync(
  fsm: object.JsObject,
  fd: Float,
  options o: object.JsObject,
) -> object.JsObject

FileSystemManager.readSync Synchronously read from a file

read_zip_entry

</> 
pub fn read_zip_entry(
  fsm: object.JsObject,
  file_path fp: String,
  encoding e: String,
  entries en: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.readZipEntry Read ZIP archive entry

readdir

</> 
pub fn readdir(
  fsm: object.JsObject,
  dir d: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.readdir Read directory contents

readdir_sync

</> 
pub fn readdir_sync(
  fsm: object.JsObject,
  dir d: String,
) -> object.JsObject

FileSystemManager.readdirSync Synchronously read directory contents

remove_saved_file

</> 
pub fn remove_saved_file(
  fsm: object.JsObject,
  file f: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.removeSavedFile Remove a saved file

rename

</> 
pub fn rename(
  fsm: object.JsObject,
  old_path o: String,
  new_path n: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.rename Rename a file or directory

rename_sync

</> 
pub fn rename_sync(
  fsm: object.JsObject,
  old_path o: String,
  new_path n: String,
) -> Nil

FileSystemManager.renameSync Synchronously rename a file or directory

rmdir

</> 
pub fn rmdir(
  fsm: object.JsObject,
  dir d: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.rmdir Remove a directory

rmdir_sync

</> 
pub fn rmdir_sync(fsm: object.JsObject, dir d: String) -> Nil

FileSystemManager.rmdirSync Synchronously remove a directory

save_file

</> 
pub fn save_file(
  fsm: object.JsObject,
  temp_file_path t: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.saveFile Save a file

save_file_sync

</> 
pub fn save_file_sync(
  fsm: object.JsObject,
  temp_file_path t: String,
) -> String

FileSystemManager.saveFileSync Synchronously save a file

save_file_to_disk

</> 
pub fn save_file_to_disk(
  temp_file_path t: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Phase 11: File Advanced

wx.saveFileToDisk Save a temporary file to local disk

stat

</> 
pub fn stat(
  fsm: object.JsObject,
  path p: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.stat Get file statistics

stat_sync

</> 
pub fn stat_sync(
  fsm: object.JsObject,
  path p: String,
) -> object.JsObject

FileSystemManager.statSync Synchronously get file statistics

stats_is_directory

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

Stats.isDirectory Check if path is a directory

stats_is_file

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

Stats.isFile Check if path is a file

truncate

</> 
pub fn truncate(
  fsm: object.JsObject,
  path p: String,
  length l: Int,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Phase 21: File Advanced

FileSystemManager.truncate Truncate a file

truncate_sync

</> 
pub fn truncate_sync(
  fsm: object.JsObject,
  path p: String,
  length l: Int,
) -> Nil

FileSystemManager.truncateSync Synchronously truncate a file

</> 
pub fn unlink(
  fsm: object.JsObject,
  file f: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.unlink Delete a file

</> 
pub fn unlink_sync(fsm: object.JsObject, file f: String) -> Nil

FileSystemManager.unlinkSync Synchronously delete a file

unzip

</> 
pub fn unzip(
  fsm: object.JsObject,
  zip_path z: String,
  target_path t: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.unzip Unzip a file

write

</> 
pub fn write(
  fsm: object.JsObject,
  fd: Float,
  data d: object.JsObject,
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.write Write to a file

write_file

</> 
pub fn write_file(
  fsm: object.JsObject,
  path p: String,
  data d: object.JsObject,
  encoding e: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

FileSystemManager.writeFile Write to a file

write_file_sync

</> 
pub fn write_file_sync(
  fsm: object.JsObject,
  path p: String,
  data d: object.JsObject,
  encoding e: String,
) -> Nil

FileSystemManager.writeFileSync Synchronously write to a file

write_sync

</> 
pub fn write_sync(
  fsm: object.JsObject,
  fd: Float,
  data d: object.JsObject,
  options o: object.JsObject,
) -> Int

FileSystemManager.writeSync Synchronously write to a file

✨ Search Document