Amber Documentation

FileSystem

`dir_create`

pub fun dir_create(path: Text): Null?

Creates a directory with all parent directories as required.

Usage

import { dir_create } from "std/fs"

dir_create("/tmp/my/nested/directory")

`dir_exists`

pub fun dir_exists(path: Text): Bool

Checks if a directory exists.

Usage

import { dir_exists } from "std/fs"

if dir_exists("/tmp/mydir") {
    echo("Directory exists")
}

`file_append`

pub fun file_append(path: Text, content: Text): Text?

Appends content to a file.

Doesn't check if the file exists.

Usage

import { file_append } from "std/fs"

file_append("log.txt", "New log entry")

`file_chmod`

pub fun file_chmod(path: Text, mode: Text): Null?

Changes the permission bits of a file.

If the file doesn't exist, it fails and prints a message.

Usage

import { file_chmod } from "std/fs"

file_chmod("script.sh", "755")

`file_chown`

pub fun file_chown(path: Text, user: Text): Null?

Changes the owner of a file.

If the file doesn't exist, it fails and prints a message.

Usage

import { file_chown } from "std/fs"

file_chown("/var/www/html", "www-data")

`file_compress`

pub fun file_compress(files: [Text], target: Text): Null?

Compress file(s) or directories into an archive
Supports: bz2, gz, xz, bz2, deb, rar, rpm, tar(gz/xz/bz), zip(war/jar), 7z
Note: Not all supported methods support multiple files/directories

Usage

import { file_compress } from "std/fs"

file_compress(["main.ab", "src"], "amber.tar.gz")?
file_compress(["amber"], "amber.gz")?

`file_exists`

pub fun file_exists(path: Text): Bool

Checks if a file exists.

Usage

import { file_exists } from "std/fs"

if file_exists("config.txt") {
    echo("File exists")
}

`file_extract`

pub fun file_extract(path: Text, target: Text): Null?

Extract the file detecting from the filename the extension
Supports: bz2, gz, xz, bz2, deb, rar, rpm, tar(gz/xz/bz), zip(war/jar), 7z
Note: Not all the commands supports the output folder path

Usage

import { file_extract } from "std/fs"

file_extract("archive.tar.gz", "/tmp/extracted")

`file_glob`

pub fun file_glob(path: Text): [Text]

Finds all files or directories matching a file glob.

Usage

import { file_glob } from "std/fs"

let files = file_glob("*.txt")

`file_glob_all`

pub fun file_glob_all(paths: [Text]): [Text]

Finds all files or directories matching multiple file globs. When
we have union types, this functionality can be merged into the main
file_glob function.

Usage

import { file_glob_all } from "std/fs"

let files = file_glob_all(["*.txt", "*.md"])

`file_read`

pub fun file_read(path: Text): Text?

Gets file contents from a path.

Usage

import { file_read } from "std/fs"

let content = file_read("data.txt")

`file_write`

pub fun file_write(path: Text, content: Text): Text?

Writes content to a file.
Doesn't check if the file exist

Usage

import { file_write } from "std/fs"

file_write("output.txt", "Hello, World!")

`is_mac_os_mktemp`

fun is_mac_os_mktemp(): Bool

Determine whether mktemp is macOS's.

import { is_mac_os_mktemp } from "std/fs"

`symlink_create`

pub fun symlink_create(origin: Text, destination: Text): Null?

Creates a symbolic link, if destination exists it will be replaced.

If the file doesn't exist, it fails and prints a message.

Usage

import { symlink_create } from "std/fs"

symlink_create("/usr/bin/python3", "/usr/local/bin/python")

`temp_dir_create`

pub fun temp_dir_create(template: Text = "tmp.XXXXXXXXXX", auto_delete: Bool = false, force_delete: Bool = false): Text?

Create a temporary directory and return the path.
Please note this does not respect _CS_DARWIN_USER_TEMP_DIR environment variable.

Usage

import { temp_dir_create } from "std/fs"

let temp = temp_dir_create("myapp.XXXXXX", true, false)

Environment

27/42

HTTP