fio - v1.0.0

fio

Values

append

</> 
pub fn append(
  path: String,
  content: String,
) -> Result(Nil, error.FioError)

Append UTF-8 text to a file (creates if missing).

append_bits

</> 
pub fn append_bits(
  path: String,
  content: BitArray,
) -> Result(Nil, error.FioError)

Append raw bytes (BitArray) to a file.

base_name

</> 
pub fn base_name(path_str: String) -> String

Get the base name (filename) of a path.

checksum

</> 
pub fn checksum(
  path: String,
  algorithm: types.HashAlgorithm,
) -> Result(String, error.FioError)

Compute a file checksum using the specified algorithm. Returns a hex-encoded string.

copy

</> 
pub fn copy(
  src: String,
  dest: String,
) -> Result(Nil, error.FioError)

Copy a file from source to destination.

copy_directory

</> 
pub fn copy_directory(
  src: String,
  dest: String,
) -> Result(Nil, error.FioError)

Recursively copy a directory and its contents.

create_directory

</> 
pub fn create_directory(
  path: String,
) -> Result(Nil, error.FioError)

Create a directory. Parent directory must exist.

create_directory_all

</> 
pub fn create_directory_all(
  path: String,
) -> Result(Nil, error.FioError)

Create a directory and all parent directories.

</> 
pub fn create_hard_link(
  target target: String,
  link link: String,
) -> Result(Nil, error.FioError)

Create a hard link to an existing file.

</> 
pub fn create_symlink(
  target target: String,
  link link: String,
) -> Result(Nil, error.FioError)

Create a symbolic link.

current_directory

</> 
pub fn current_directory() -> Result(String, error.FioError)

Get the current working directory.

delete

</> 
pub fn delete(path: String) -> Result(Nil, error.FioError)

Delete a file (not a directory).

delete_all

</> 
pub fn delete_all(path: String) -> Result(Nil, error.FioError)

Delete a path recursively; idempotent (succeeds if missing).

delete_directory

</> 
pub fn delete_directory(
  path: String,
) -> Result(Nil, error.FioError)

Delete an empty directory.

directory_name

</> 
pub fn directory_name(path_str: String) -> String

Get the directory portion of a path.

exists

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

Check if a path exists (file, directory, or symlink).

expand

</> 
pub fn expand(path_str: String) -> Result(String, Nil)

Expand/normalize a path, resolving . and .. segments. Returns Error(Nil) if .. would go above the root.

extension

</> 
pub fn extension(path_str: String) -> Result(String, Nil)

Get the file extension (without dot).

file_info

</> 
pub fn file_info(
  path: String,
) -> Result(types.FileInfo, error.FioError)

Get file metadata (follows symlinks).

is_absolute

</> 
pub fn is_absolute(path_str: String) -> Bool

Check if a path is absolute.

is_directory

</> 
pub fn is_directory(path: String) -> Result(Bool, error.FioError)

Check if a path is a directory (follows symlinks).

is_file

</> 
pub fn is_file(path: String) -> Result(Bool, error.FioError)

Check if a path is a regular file (follows symlinks).

</> 
pub fn is_symlink(path: String) -> Result(Bool, error.FioError)

Check if a path is a symbolic link (does not follow symlinks).

join

</> 
pub fn join(left: String, right: String) -> String

Join two path segments.

join_all

</> 
pub fn join_all(segments: List(String)) -> String

Join a list of path segments.

</> 
pub fn link_info(
  path: String,
) -> Result(types.FileInfo, error.FioError)

Get file metadata without following symlinks.

list

</> 
pub fn list(path: String) -> Result(List(String), error.FioError)

List the contents of a directory (names only).

list_recursive

</> 
pub fn list_recursive(
  path: String,
) -> Result(List(String), error.FioError)

Recursively list files and directories (paths relative to path).

read

</> 
pub fn read(path: String) -> Result(String, error.FioError)

Read a UTF-8 text file. Returns NotUtf8(path) on invalid UTF-8.

read_bits

</> 
pub fn read_bits(
  path: String,
) -> Result(BitArray, error.FioError)

Read a file as raw bytes (BitArray).

</> 
pub fn read_link(path: String) -> Result(String, error.FioError)

Read the target path of a symbolic link.

rename

</> 
pub fn rename(
  src: String,
  dest: String,
) -> Result(Nil, error.FioError)

Rename or move a file or directory.

safe_relative

</> 
pub fn safe_relative(path_str: String) -> Result(String, Nil)

Validate that a path is a safe relative path (does not escape root). On Windows it also normalizes backslashes into /.

set_permissions

</> 
pub fn set_permissions(
  path: String,
  permissions: types.FilePermissions,
) -> Result(Nil, error.FioError)

Set file permissions using the FilePermissions type.

set_permissions_octal

</> 
pub fn set_permissions_octal(
  path: String,
  mode: Int,
) -> Result(Nil, error.FioError)

Set file permissions with an octal integer.

split

</> 
pub fn split(path_str: String) -> List(String)

Split a path into its segments.

stem

</> 
pub fn stem(path_str: String) -> String

Get the stem (filename without extension).

strip_extension

</> 
pub fn strip_extension(path_str: String) -> String

Remove the extension from a path.

tmp_dir

</> 
pub fn tmp_dir() -> String

Get the system temporary directory path.

touch

</> 
pub fn touch(path: String) -> Result(Nil, error.FioError)

Touch a file: create or update modification time.

verify_checksum

</> 
pub fn verify_checksum(
  path: String,
  expected: String,
  algorithm: types.HashAlgorithm,
) -> Result(Bool, error.FioError)

Verify that a file’s checksum matches the expected hex-encoded hash.

with_extension

</> 
pub fn with_extension(path_str: String, ext: String) -> String

Change the extension of a path.

with_temp_directory

</> 
pub fn with_temp_directory(
  callback: fn(String) -> Result(a, error.FioError),
) -> Result(a, error.FioError)

Run a callback with a path to a temporary directory that is automatically deleted (recursively) when the callback returns.

with_temp_file

</> 
pub fn with_temp_file(
  callback: fn(String) -> Result(a, error.FioError),
) -> Result(a, error.FioError)

Run a callback with a path to a temporary file that is automatically deleted when the callback returns (even if it returns an Error).

write

</> 
pub fn write(
  path: String,
  content: String,
) -> Result(Nil, error.FioError)

Write UTF-8 text to a file (creates/overwrites).

write_atomic

</> 
pub fn write_atomic(
  path: String,
  content: String,
) -> Result(Nil, error.FioError)

Write UTF-8 text atomically: writes to a sibling temp file, then renames it into place with a single rename(2) syscall. Readers never observe partial content. Returns AtomicFailed on error.

write_bits

</> 
pub fn write_bits(
  path: String,
  content: BitArray,
) -> Result(Nil, error.FioError)

Write raw bytes (BitArray) to a file (creates/overwrites).

write_bits_atomic

</> 
pub fn write_bits_atomic(
  path: String,
  content: BitArray,
) -> Result(Nil, error.FioError)

Write raw bytes (BitArray) atomically. Same atomic guarantee as write_atomic.

✨ Search Document