Vfs

class

Public Class Vfs

Local files = Vfs()
Local embedded = {"config.txt": "size = 3".Bytes, "levels/one.txt": "first".Bytes}
files.MountEmbedded(Path("data"), embedded)
Expect((Try files.ReadText(Path("data/config.txt"))) == "size = 3")
Expect(files.DirExists(Path("data/levels")))
Expect(!files.Exists(Path("data/missing.txt")))

std/io/vfs.fb, line 196

• Public New() constructor #

  A new Vfs, with nothing mounted.

• @PanicsAtCaller Public Method Mount(at: Path, source: VfsSource) method #

  Puts the source at at, a path in the Vfs, "" or "/" for its root, before what's mounted already. Panics for a path that goes above the root.

• @PanicsAtCaller Public Method MountFolder(at: Path, folder: Path) method #

  Mounts a folder on the disk at at.

• @PanicsAtCaller Public Method MountEmbedded(at: Path, files: Map<String, UInt8[]>) method #

  Mounts files in memory, like what EmbedFolder gives, at at.

• Public Method Unmount(at: Path): Bool method #

  Takes out the last mount at at, and gives whether there was one.

• Public Method ReadBytes(path: Path): UInt8[] Throws IOError method #

  The bytes of the file at path. One that no mount has throws an IOError of NOT_FOUND, a folder one of IS_A_DIRECTORY, and a path above the root one of INVALID_PATH.

• Public Async Method ReadBytesAsync(path: Path): UInt8[] Throws IOError method #

  ReadBytes's Async twin, which reads a folder's files without blocking the main thread. It reads the mounts there were when it began, whatever's mounted while it waits.

• Public Method ReadText(path: Path): String Throws IOError method #

  The file's bytes as text, with U+FFFD for each one that doesn't start well-formed UTF-8.

• Public Async Method ReadTextAsync(path: Path): String Throws IOError method #

  What ReadText does, without blocking its thread: a call gives its Task.

• Public Method ReadLines(path: Path): String[] Throws IOError method #

  The file's text in lines, split at "\n" and "\r\n", as File.ReadLines splits them.

• Public Async Method ReadLinesAsync(path: Path): String[] Throws IOError method #

  What ReadLines does, without blocking its thread: a call gives its Task.

• Public Method KindOf(path: Path): FileKind? Throws IOError method #

  What's at path: a file or a folder some mount has, or a folder a mount is in or at, or Null. What two mounts have is the last one's, as Entries finds it.

• Public Method Exists(path: Path): Bool method #

  Whether there's a file at path, as KindOf finds it; an error is False.

• Public Method DirExists(path: Path): Bool method #

  Whether there's a folder at path, as KindOf finds it; an error is False.

• Public Method Entries(): DirEntry[] Throws IOError method #

  What's in the Vfs's root.

• Public Method Entries(path: Path): DirEntry[] Throws IOError method #

  What's in the folder at path, from every mount that has it, and the mounts in it, in the order of their names' bytes. A name two mounts have is the last one's. A folder no mount has throws an IOError of NOT_FOUND, a file one of NOT_A_DIRECTORY, and a path above the root one of INVALID_PATH.

• Public Method Walk(): DirEntry[] Throws IOError method #

  What's in the Vfs, all the way down, each folder before what's in it.

• Public Method Walk(path: Path): DirEntry[] Throws IOError method #

  What's in the folder at path and in each folder in it, all the way down, each folder before what's in it, and each folder's entries in the order of their names' bytes. It throws as Entries does.

• Public Method Glob(path: Path, pattern: String): DirEntry[] Throws IOError method #

  What's in the folder at path, and in the folders in it, whose path from it matches pattern, as Dir.Glob's patterns match, with '/' or '' between its names on every OS, as between a Vfs path's. It throws as Entries does.