Minilib.IO.FileSystem
Defined in minilib-io@0.6.12
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
chdir
Type: Std::Path -> Std::IO::IOFail ()
chdir(path) changes the current working directory of the calling process to the specified directory.
Parameters
dir_path: a directory path
creat
Type: Std::String -> Std::U32 -> Std::IO::IOFail Std::FFI::CInt
Creates a new file or rewrites an existing one.
For details, see Linux manual page for creat(3p).
Parameters
path: a file path to be createdmode: a file mode of the created file
directory_exists
Type: Std::String -> Std::IO Std::Bool
Returns true if the specified directory exists.
Parameters
dir_path: a directory path
fdopen
Type: Std::FFI::CInt -> Std::String -> Std::IO::IOFail Std::IO::IOHandle
Associates a stream with a file descriptor.
For details, see Linux manual page for fdopen(3p).
Parameters
fd: a file descriptormodea file open mode, such as "r", "w", "a" etc.
file_exists
Type: Std::String -> Std::IO Std::Bool
Returns true if the specified file exists.
Parameters
file_path: a file path
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"]
Parameters
dir_path: a directory path
getcwd
Type: Std::IO::IOFail Std::String
getcwd returns an absolute pathname of the current working directory.
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.
Parameters
dir_path: a directory path
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.
Parameters
dir_path: the directory path to be createdmode:some()of a file mode of the created directories, ornone()
mkdir
Type: Std::String -> Std::Option Std::U32 -> Std::IO::IOFail ()
mkdir(dir_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.
Parameters
dir_path: the directory path to be createdmode:some()of a file mode of the created directory, ornone()
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::FFI::CInt, Std::FFI::CInt)
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).
Parameters
path: a file or directory path, which may be a relative path
rmdir
Type: Std::String -> Std::IO::IOFail ()
rmdir(path) deletes a directory, which must be empty.
Parameters
dir_path: the directory path to be deleted
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).
Parameters
path: a file path to be deleted
namespace Minilib.IO.FileSystem::FileStat
is_dir
Type: Minilib.IO.FileSystem::FileStat -> Std::Bool
Returns true if it is a directory.
Parameters
file_stat: a file status obtained bystat
is_file
Type: Minilib.IO.FileSystem::FileStat -> Std::Bool
Returns true if it is a regular file.
Parameters
file_stat: a file status obtained bystat
st_atim
Type: Minilib.IO.FileSystem::FileStat -> Time::Time
st_atime
Type: Minilib.IO.FileSystem::FileStat -> Std::U64
st_blksize
Type: Minilib.IO.FileSystem::FileStat -> Std::I64
st_blocks
Type: Minilib.IO.FileSystem::FileStat -> Std::U64
st_ctim
Type: Minilib.IO.FileSystem::FileStat -> Time::Time
st_ctime
Type: Minilib.IO.FileSystem::FileStat -> Std::U64
st_dev
Type: Minilib.IO.FileSystem::FileStat -> Std::U64
st_gid
Type: Minilib.IO.FileSystem::FileStat -> Std::U32
st_ino
Type: Minilib.IO.FileSystem::FileStat -> Std::U64
st_mode
Type: Minilib.IO.FileSystem::FileStat -> Std::U32
st_mtim
Type: Minilib.IO.FileSystem::FileStat -> Time::Time
st_mtime
Type: Minilib.IO.FileSystem::FileStat -> Std::U64
st_nlink
Type: Minilib.IO.FileSystem::FileStat -> Std::U64
st_rdev
Type: Minilib.IO.FileSystem::FileStat -> Std::U64
st_size
Type: Minilib.IO.FileSystem::FileStat -> Std::I64
st_uid
Type: Minilib.IO.FileSystem::FileStat -> Std::U32
stat
Type: Std::String -> Std::IO::IOFail Minilib.IO.FileSystem::FileStat
stat(file_path) retrieves information about the file pointed to by file_path.
For detials, see Linux manual page for stat(2) and stat(3type).
Parameters
file_path: a file path
Types and aliases
namespace Minilib.IO.FileSystem
DirHandle
Defined as: type DirHandle = unbox struct { ...fields... }
Type of a directory handle (used internally)
field dtor
Type: Std::FFI::Destructor Std::Ptr
FileStat
Defined as: type FileStat = unbox struct { ...fields... }
Type of file status
field data
Type: Std::Array Std::U64