Skip to content

File filesystem.h

Headers > cais > filesystem.h

Go to the source code of this file

  • #include <stddef.h>
  • #include <cais/types.h>

Data Structures

Type Name
struct cais_fs_dirent_t
Directory entry structure yielded during directory traversal.
struct cais_fs_stat_t
File or directory metadata status structure.

Types

Type Name
typedef struct cais_file cais_file_t
typedef struct cais_fs_dir cais_fs_dir_t
enum cais_fs_type_t
typedef unsigned long cais_fsize_t

Functions

Type Name
void cais_file_close (cais_file_t * f)
cais_status_t cais_file_flush (cais_file_t * f)
cais_file_t * cais_file_open (const char * path, const char * mode, char * err_buf, size_t err_cap)
cais_status_t cais_file_read (cais_file_t * f, void * buf, size_t count, size_t * bytes_read)
cais_status_t cais_file_seek (cais_file_t * f, long offset, int whence, long * new_pos)
cais_status_t cais_file_tell (cais_file_t * f, long * pos)
cais_status_t cais_file_write (cais_file_t * f, const void * buf, size_t count, size_t * bytes_written)
cais_status_t cais_fs_append_file (const char * path, const void * buf, size_t len, char * err_buf, size_t err_cap)
cais_status_t cais_fs_chmod (const char * path, int mode, char * err_buf, size_t err_cap)
cais_status_t cais_fs_copy_file (const char * src, const char * dst, cais_bool_t overwrite, char * err_buf, size_t err_cap)
void cais_fs_dir_close (cais_fs_dir_t * dir)
cais_status_t cais_fs_dir_next (cais_fs_dir_t * dir, cais_fs_dirent_t * ent)
cais_fs_dir_t * cais_fs_dir_open (const char * path, char * err_buf, size_t err_cap)
cais_bool_t cais_fs_exists (const char * path)
cais_status_t cais_fs_file_size (const char * path, cais_fsize_t * out_size)
cais_status_t cais_fs_getcwd (char * buf, size_t cap, char * err_buf, size_t err_cap)
cais_bool_t cais_fs_is_dir (const char * path)
cais_bool_t cais_fs_is_file (const char * path)
cais_bool_t cais_fs_is_symlink (const char * path)
cais_status_t cais_fs_lstat (const char * path, cais_fs_stat_t * st, char * err_buf, size_t err_cap)
cais_status_t cais_fs_mkdir (const char * path, int mode, char * err_buf, size_t err_cap)
cais_status_t cais_fs_mkdir_p (const char * path, int mode, char * err_buf, size_t err_cap)
cais_status_t cais_fs_path_basename (const char * path, char * out, size_t out_cap)
cais_status_t cais_fs_path_dirname (const char * path, char * out, size_t out_cap)
cais_status_t cais_fs_path_ext (const char * path, char * out, size_t out_cap)
cais_bool_t cais_fs_path_is_absolute (const char * path)
cais_status_t cais_fs_path_join (const char * p1, const char * p2, char * out, size_t out_cap)
cais_status_t cais_fs_path_normalize (const char * path, char * out, size_t out_cap)
char cais_fs_path_separator (void)
cais_status_t cais_fs_read_file (const char * path, void ** out_buf, size_t * out_len, char * err_buf, size_t err_cap)
cais_status_t cais_fs_remove (const char * path, char * err_buf, size_t err_cap)
cais_status_t cais_fs_remove_all (const char * path, char * err_buf, size_t err_cap)
cais_status_t cais_fs_rename (const char * oldpath, const char * newpath, char * err_buf, size_t err_cap)
cais_status_t cais_fs_rmdir (const char * path, char * err_buf, size_t err_cap)
cais_status_t cais_fs_setcwd (const char * path, char * err_buf, size_t err_cap)
cais_status_t cais_fs_stat (const char * path, cais_fs_stat_t * st, char * err_buf, size_t err_cap)
cais_status_t cais_fs_temp_dir (char * buf, size_t cap, char * err_buf, size_t err_cap)
cais_status_t cais_fs_write_file (const char * path, const void * buf, size_t len, char * err_buf, size_t err_cap)

Macros

Type Name
define CAIS_FS_SEEK_CUR 1
define CAIS_FS_SEEK_END 2
define CAIS_FS_SEEK_SET 0
define CAIS_PATH_MAX 1024

Type Details

cais_file_t

typedef struct cais_file cais_file_t;

cais_fs_dir_t

typedef struct cais_fs_dir cais_fs_dir_t;

enum cais_fs_type_t

enum cais_fs_type_t {
    CAIS_FS_TYPE_UNKNOWN = 0,
    CAIS_FS_TYPE_FILE = 1,
    CAIS_FS_TYPE_DIR = 2,
    CAIS_FS_TYPE_SYMLINK = 3,
    CAIS_FS_TYPE_DEVICE = 4,
    CAIS_FS_TYPE_FIFO = 5,
    CAIS_FS_TYPE_SOCKET = 6
};

cais_fsize_t

typedef unsigned long cais_fsize_t;

Function Details

cais_file_close

void cais_file_close (
    cais_file_t * f
) 

cais_file_flush

cais_status_t cais_file_flush (
    cais_file_t * f
) 

cais_file_open

cais_file_t * cais_file_open (
    const char * path,
    const char * mode,
    char * err_buf,
    size_t err_cap
) 

cais_file_read

cais_status_t cais_file_read (
    cais_file_t * f,
    void * buf,
    size_t count,
    size_t * bytes_read
) 

cais_file_seek

cais_status_t cais_file_seek (
    cais_file_t * f,
    long offset,
    int whence,
    long * new_pos
) 

cais_file_tell

cais_status_t cais_file_tell (
    cais_file_t * f,
    long * pos
) 

cais_file_write

cais_status_t cais_file_write (
    cais_file_t * f,
    const void * buf,
    size_t count,
    size_t * bytes_written
) 

cais_fs_append_file

cais_status_t cais_fs_append_file (
    const char * path,
    const void * buf,
    size_t len,
    char * err_buf,
    size_t err_cap
) 

cais_fs_chmod

cais_status_t cais_fs_chmod (
    const char * path,
    int mode,
    char * err_buf,
    size_t err_cap
) 

cais_fs_copy_file

cais_status_t cais_fs_copy_file (
    const char * src,
    const char * dst,
    cais_bool_t overwrite,
    char * err_buf,
    size_t err_cap
) 

cais_fs_dir_close

void cais_fs_dir_close (
    cais_fs_dir_t * dir
) 

cais_fs_dir_next

cais_status_t cais_fs_dir_next (
    cais_fs_dir_t * dir,
    cais_fs_dirent_t * ent
) 

cais_fs_dir_open

cais_fs_dir_t * cais_fs_dir_open (
    const char * path,
    char * err_buf,
    size_t err_cap
) 

cais_fs_exists

cais_bool_t cais_fs_exists (
    const char * path
) 

cais_fs_file_size

cais_status_t cais_fs_file_size (
    const char * path,
    cais_fsize_t * out_size
) 

cais_fs_getcwd

cais_status_t cais_fs_getcwd (
    char * buf,
    size_t cap,
    char * err_buf,
    size_t err_cap
) 

cais_fs_is_dir

cais_bool_t cais_fs_is_dir (
    const char * path
) 

cais_fs_is_file

cais_bool_t cais_fs_is_file (
    const char * path
) 

cais_bool_t cais_fs_is_symlink (
    const char * path
) 

cais_fs_lstat

cais_status_t cais_fs_lstat (
    const char * path,
    cais_fs_stat_t * st,
    char * err_buf,
    size_t err_cap
) 

cais_fs_mkdir

cais_status_t cais_fs_mkdir (
    const char * path,
    int mode,
    char * err_buf,
    size_t err_cap
) 

cais_fs_mkdir_p

cais_status_t cais_fs_mkdir_p (
    const char * path,
    int mode,
    char * err_buf,
    size_t err_cap
) 

cais_fs_path_basename

cais_status_t cais_fs_path_basename (
    const char * path,
    char * out,
    size_t out_cap
) 

cais_fs_path_dirname

cais_status_t cais_fs_path_dirname (
    const char * path,
    char * out,
    size_t out_cap
) 

cais_fs_path_ext

cais_status_t cais_fs_path_ext (
    const char * path,
    char * out,
    size_t out_cap
) 

cais_fs_path_is_absolute

cais_bool_t cais_fs_path_is_absolute (
    const char * path
) 

cais_fs_path_join

cais_status_t cais_fs_path_join (
    const char * p1,
    const char * p2,
    char * out,
    size_t out_cap
) 

cais_fs_path_normalize

cais_status_t cais_fs_path_normalize (
    const char * path,
    char * out,
    size_t out_cap
) 

cais_fs_path_separator

char cais_fs_path_separator (
    void
) 

cais_fs_read_file

cais_status_t cais_fs_read_file (
    const char * path,
    void ** out_buf,
    size_t * out_len,
    char * err_buf,
    size_t err_cap
) 

cais_fs_remove

cais_status_t cais_fs_remove (
    const char * path,
    char * err_buf,
    size_t err_cap
) 

cais_fs_remove_all

cais_status_t cais_fs_remove_all (
    const char * path,
    char * err_buf,
    size_t err_cap
) 

cais_fs_rename

cais_status_t cais_fs_rename (
    const char * oldpath,
    const char * newpath,
    char * err_buf,
    size_t err_cap
) 

cais_fs_rmdir

cais_status_t cais_fs_rmdir (
    const char * path,
    char * err_buf,
    size_t err_cap
) 

cais_fs_setcwd

cais_status_t cais_fs_setcwd (
    const char * path,
    char * err_buf,
    size_t err_cap
) 

cais_fs_stat

cais_status_t cais_fs_stat (
    const char * path,
    cais_fs_stat_t * st,
    char * err_buf,
    size_t err_cap
) 

cais_fs_temp_dir

cais_status_t cais_fs_temp_dir (
    char * buf,
    size_t cap,
    char * err_buf,
    size_t err_cap
) 

cais_fs_write_file

cais_status_t cais_fs_write_file (
    const char * path,
    const void * buf,
    size_t len,
    char * err_buf,
    size_t err_cap
) 

Macro Details

CAIS_FS_SEEK_CUR

#define CAIS_FS_SEEK_CUR `1`

CAIS_FS_SEEK_END

#define CAIS_FS_SEEK_END `2`

CAIS_FS_SEEK_SET

#define CAIS_FS_SEEK_SET `0`

CAIS_PATH_MAX

#define CAIS_PATH_MAX `1024`


The documentation was generated from the following file: include/cais/filesystem.h