openNGVFS/docs/init_wasi_import.yaml

ngvfs_init:
  api_ver_get:
    desc: "获得NGVFS API版本"
    params:
      - name: ptrMajorVersion
        type: i32
        xtyp: "*mut i32"
        desc: "存放获取到的MajorVersion的i32变量指针"
      - name: ptrMinorVersion
        type: i32
        xtyp: "*mut i32"
        desc: "存放获取到的MinorVersion的i32变量指针"
      - name: ptrPatchVersion
        type: i32
        xtyp: "*mut i32"
        desc: "存放获取到的PatchVersion的i32变量指针"
  exkv_get_len:
    desc: "通过key获得exkv中value的长度"
    params:
      - name: ptrKey
        type: i32
        xtyp: "*const u8"
        desc: "key的指针"
      - name: lenKey
        type: i32
        xtyp: "usize"
        desc: "key的长度"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-2": "key不存在"
          "-1": "读取key时内存越界"
          ">=0": "返回值即为value的长度"
  exkv_get_val:
    desc: "通过key获得exkv中的value"
    params:
      - name: ptrKey
        type: i32
        xtyp: "*const u8"
        desc: "key的指针"
      - name: lenKey
        type: i32
        xtyp: "usize"
        desc: "key的长度"
      - name: ptrBuf
        type: i32
        xtyp: "*mut u8"
        desc: "存放值的缓冲区指针"
      - name: lenBuf
        type: i32
        xtyp: "usize"
        desc: "缓冲区长度。缓冲区不足则值会被截断"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-3": "写入buf时内存越界"
          "-2": "key不存在"
          "-1": "读取key时内存越界"
          "0": "缓冲区长度小于等于0"
          ">0": "写入缓冲区的值的长度"
  vfs_mount:
    desc: "挂载指定句柄的afs文件系统实例至指定挂载点"
    params:
      - name: hAfs
        type: i32
        desc: "afs实例句柄"
      - name: ptrMntPath
        type: i32
        xtyp: "*const u8"
        desc: "挂载点路径的指针"
      - name: lenMntPath
        type: i32
        xtyp: "usize"
        desc: "挂载点路径的长度"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-4": "挂载时发生内部错误，详见日志"
          "-3": "挂载点已经被挂载"
          "-2": "读取挂载点路径时内存越界"
          "-1": "afs句柄无效"
          "0": "挂载成功"
  vfs_mkdir:
    desc: "创建目录，类似mkdir -p，用于准备挂载点"
    params:
      - name: ptrPath
        type: i32
        xtyp: "*const u8"
        desc: "目录路径的指针"
      - name: lenPath
        type: i32
        xtyp: "usize"
        desc: "目录路径的长度"
      - name: mode
        type: i32
        desc: "目录的权限模式"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-2": "创建目录失败，详见日志"
          "-1": "读取路径时内存越界"
          "0": "创建成功"
  afs_free:
    desc: "释放指定句柄的afs实例"
    params:
      - name: hAfs
        type: i32
        desc: "afs实例句柄"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-1": "句柄不存在"
          "0": "释放成功"
  afs_mkdir:
    desc: "在afero.Fs实例上创建目录，类似mkdir -p，用于准备挂载点，但是是在afero.Fs实例上进行。"
    params:
      - name: hAfs
        type: i32
        desc: "afs实例句柄"
      - name: ptrPath
        type: i32
        xtyp: "*const u8"
        desc: "Path的指针"
      - name: lenPath
        type: i32
        xtyp: "usize"
        desc: "Path的长度"
      - name: mode
        type: i32
        desc: "目录的权限模式"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-3": "读取Path时内存越界"
          "-2": "afs实例句柄无效"
          "-1": "创建目录失败，详见日志"
          "0": "创建目录成功"
  afs_create_osfs:
    desc: "创建afero.OsFs实例"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-1": "申请afs句柄资源失败"
          ">0": "创建的afs实例的句柄"
  afs_create_memfs:
    desc: "创建afero.MemMapFs实例"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-1": "申请afs句柄资源失败"
          ">0": "创建的afs实例的句柄"
  afs_create_bpfs:
    desc: "创建afero.BasePathFs实例"
    params:
      - name: hBaseAfs
        type: i32
        desc: "基于的afs实例句柄"
      - name: ptrBasePath
        type: i32
        xtyp: "*const u8"
        desc: "BasePath的指针"
      - name: lenBasePath
        type: i32
        xtyp: "usize"
        desc: "BasePath的长度"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-3": "读取BasePath时内存越界"
          "-2": "afs实例句柄无效"
          "-1": "申请afs句柄资源失败"
          ">0": "创建的afs实例的句柄"
  afs_create_regfs:
    desc: "创建afero.RegexpFs实例，使用字符串形式的golang正则表达式"
    params:
      - name: hBaseAfs
        type: i32
        desc: "基于的afs实例句柄"
      - name: ptrRegExp
        type: i32
        xtyp: "*const u8"
        desc: "RegExp的指针"
      - name: lenRegExp
        type: i32
        xtyp: "usize"
        desc: "RegExp的长度"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-4": "编译正则表达式失败"
          "-3": "读取RegExp时内存越界"
          "-2": "afs实例句柄无效"
          "-1": "申请afs句柄资源失败"
          ">0": "创建的afs实例的句柄"
  afs_create_rofs:
    desc: "创建afero.ReadOnlyFs实例"
    params:
      - name: hBaseAfs
        type: i32
        desc: "基于的afs实例句柄"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-2": "afs实例句柄无效"
          "-1": "申请afs句柄资源失败"
          ">0": "创建的afs实例的句柄"
  afs_create_cowfs:
    desc: "创建afero.CopyOnWriteFs实例"
    params:
      - name: hRoAfs
        type: i32
        desc: "基于的只读afs实例句柄"
      - name: hWrAfs
        type: i32
        desc: "基于的可写afs实例句柄"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-3": "可写afs实例句柄无效"
          "-2": "只读afs实例句柄无效"
          "-1": "申请afs句柄资源失败"
          ">0": "创建的afs实例的句柄"
  afs_create_corfs:
    desc: "创建afero.CacheOnReadFs实例"
    params:
      - name: hRoAfs
        type: i32
        desc: "基于的afs实例句柄"
      - name: hWrAfs
        type: i32
        desc: "缓存afs实例句柄"
      - name: cacheTime
        type: i32
        desc: "缓存时间，单位为秒，0为永久缓存"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-4": "缓存时间小于0"
          "-3": "可写afs实例句柄无效"
          "-2": "只读afs实例句柄无效"
          "-1": "申请afs句柄资源失败"
          ">0": "创建的afs实例的句柄"
  afs_create_bep_ovfs:
    desc: "创建gtihub.com/bep/overlayfs.OverlayFs实例"
    params:
      - name: ptrAfsArray
        type: i32
        xtyp: "*const i32"
        desc: "文件系统层句柄数组的指针，数组从左往右，越左边的优先级越高"
      - name: lenAfsArray
        type: i32
        xtyp: "usize"
        desc: "文件系统层句柄数组的长度"
      - name: bWritable
        type: i32
        xtyp: "enum"
        desc: "是否允许写入"
        enum:
          "<=0": "不允许"
          ">0": "允许"
    results:
      - name: result
        type: i32
        xtyp: "enum"
        desc: "结果"
        enum:
          "-5": "申请afs句柄资源失败"
          "-4": "读取文件系统层数组时遇到无效的句柄"
          "-3": "读取文件系统层数组时元素长度不正确"
          "-2": "读取文件系统层数组时内存越界"
          "-1": "文件系统层数为0"
          ">0": "创建的afs实例的句柄"