Module `fs/dir`

fs/dir

Async directory operations — create, remove, read, link, rename.

Wraps low-level std/sys/dir with typed APIs using the Exception effect.

Example

{ create_dir, remove_dir, read_dir } :: import "std/fs/dir";
{ Path } :: import "std/path";

main :: (fn(using(io : IO)) -> unit)({
  given(exn) : Exception = {
    throw : (fn(forall(T : Type), error: AnyError) -> T)(
      { println(error.to_string()); exit(i32(1)); }
    )
  };

  io.await(create_dir(Path.new(`/tmp/yo_test`)));
  entries := io.await(read_dir(Path.new(`/tmp/yo_test`)));
  io.await(remove_dir(Path.new(`/tmp/yo_test`)));
});

Types

FileType enum

FileType

The type of a file system entry.

Variants

Variant	Fields	Description
`File`		A regular file.
`Directory`		A directory.
`Symlink`		A symbolic link.
`Other`		An unknown or unsupported file type.

DirEntry struct

DirEntry

A directory entry containing the entry name, file type, and inode number.

Fields

Name	Type	Description
`name`	String
`file_type`	FileType
`ino`	u64

Functions

create_dir function

fn(path : Path, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Create a directory at the given path.

Parameters

Name	Type	Notes
`path`	Path

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

create_dir_str function

fn(path : str, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Create a directory (str path variant).

Parameters

Name	Type	Notes
`path`	str

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

create_dir_all function

fn(path : Path, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Create a directory and all missing parent directories. Does not error if the directory already exists.

Parameters

Name	Type	Notes
`path`	Path

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

create_dir_all_str function

fn(path : str, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Create a directory and all missing parents (str path variant).

Parameters

Name	Type	Notes
`path`	str

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

remove_dir function

fn(path : Path, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Remove an empty directory. Throws if the directory is not empty.

Parameters

Name	Type	Notes
`path`	Path

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

remove_dir_str function

fn(path : str, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Parameters

Name	Type	Notes
`path`	str

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

remove_file function

fn(path : Path, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Remove a file at the given path.

Parameters

Name	Type	Notes
`path`	Path

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

remove_file_str function

fn(path : str, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Parameters

Name	Type	Notes
`path`	str

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

rename function

fn(from : Path, to : Path, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Rename or move a file or directory from from to to.

Parameters

Name	Type	Notes
`from`	Path
`to`	Path

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

rename_str function

fn(from : str, to : str, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Parameters

Name	Type	Notes
`from`	str
`to`	str

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

hard_link function

fn(src : Path, dst : Path, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Create a hard link from src to dst.

Parameters

Name	Type	Notes
`src`	Path
`dst`	Path

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

hard_link_str function

fn(src : str, dst : str, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Parameters

Name	Type	Notes
`src`	str
`dst`	str

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

symlink function

fn(src : Path, dst : Path, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Create a symbolic link at dst pointing to src.

Parameters

Name	Type	Notes
`src`	Path
`dst`	Path

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

symlink_str function

fn(src : str, dst : str, using(io : IO)) -> Impl(Future(unit, IO, Exception))

Parameters

Name	Type	Notes
`src`	str
`dst`	str

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(unit, IO, Exception))

read_dir function

fn(path : Path, using(io : IO)) -> Impl(Future(ArrayList(DirEntry), IO, Exception))

Read all entries from a directory, returning an ArrayList(DirEntry). Skips the . and .. entries.

Parameters

Name	Type	Notes
`path`	Path

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(ArrayList(DirEntry), IO, Exception))

read_dir_str function

fn(path : str, using(io : IO)) -> Impl(Future(ArrayList(DirEntry), IO, Exception))

Parameters

Name	Type	Notes
`path`	str

Effects

Name	Type	Notes
`io`	IO	comptime, implicit

Returns: Impl(Future(ArrayList(DirEntry), IO, Exception))

Module fs/dir

Example

Types

Variants

Fields

Functions

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Parameters

Effects

Module `fs/dir`