Minilib.IO.FileSystem

Defined in minilib-io@0.6.1

File system module. For example, finding files, checks if file or directory exists, getting file size and last modified time.

Values

namespace Minilib.IO.FileSystem

creat

Type: Std::String -> Std::U32 -> Std::IO::IOFail Std::I32

Creates a new file or rewrites an existing one.

For details, see Linux manual page for creat(3p).

directory_exists

Type: Std::String -> Std::IO Std::Bool

Returns true if the specified directory exists.

fdopen

Type: Std::I32 -> Std::String -> Std::IO::IOFail Std::IO::IOHandle

Associates a stream with a file descriptor.

For details, see Linux manual page for fdopen(3p).

file_exists

Type: Std::String -> Std::IO Std::Bool

Returns true if the specified file exists.

find_files

Type: Std::String -> Std::IO::IOFail (Std::Array Std::String)

find_files(dir_path) finds all files under specified directory and its subdirectories.

Example:

find_files("./lib")
==> ["./lib/io/errno.fix","./lib/io/file_system.fix","./lib/io/path.fix","./lib/io/platform.fix","./lib/io/signal.fix"]

list_dir

Type: Std::String -> Std::IO::IOFail (Std::Array Std::String)

Lists a directory. Returns filenames in the specified directory. The filenames will be sorted in lexicographical order.

make_dirs

Type: Std::String -> Std::Option Std::U32 -> Std::IO::IOFail ()

make_dirs(dir_path, mode) creates specified directory as well as its parent directories recursively. If the directory already exists, it does nothing. If mode is none(), octal 0777 is used as a mode. This mode is modified by the process's umask in the usual way.

mkdir

Type: Std::String -> Std::Option Std::U32 -> Std::IO::IOFail ()

mkdir(path, mode) creates a directory. If mode is none(), octal 0777 is used as a mode. This mode is modified by the process's umask in the usual way.

open_pipe

Type: Std::IO::IOFail (Std::IO::IOHandle, Std::IO::IOHandle)

Creates a pipe stream. It returns (read_fh, write_fh) where read_fd is the stream of read-end of the pipe, and write_fd is the stream of write-end of the pipe.

For details, see Linux manual page for pipe(2).

pipe

Type: Std::IO::IOFail (Std::I32, Std::I32)

Creates a pipe. It returns (read_fd, write_fd) where read_fd is the file descriptor of read-end of the pipe, and write_fd is the file descriptor of write-end of the pipe.

For details, see Linux manual page for pipe(2).

realpath

Type: Std::String -> Std::IO::IOFail Std::String

Returns the canonicalized absolute pathname.

For detials, see Linux manual page for realpath(3).

rmdir

Type: Std::String -> Std::IO::IOFail ()

rmdir(path) deletes a directory, which must be empty.

unlink

Type: Std::String -> Std::IO::IOFail ()

Deletes a name from the filesystem and possibly the file it refers to.

For details, see Linux manual page for unlink(2).

namespace Minilib.IO.FileSystem::FileStat

is_dir

Type: Minilib.IO.FileSystem::FileStat -> Std::Bool

Returns true if it is a directory.

is_file

Type: Minilib.IO.FileSystem::FileStat -> Std::Bool

Returns true if it is a regular file.