lv_fs.h

lv_fs_get_drv

Give a pointer to a driver from its letter

lv_fs_drv_t * lv_fs_get_drv(char letter)

Returns: lv_fs_drv_t * — pointer to a driver or NULL if not found

lv_fs_get_buffer_from_path

Get the buffer address and size from a path object

lv_result_t lv_fs_get_buffer_from_path(lv_fs_path_ex_t *path, void **buffer, uint32_t *size)

Returns: lv_result_t — LV_RESULT_OK: buffer and size are set; LV_RESULT_INVALID: an error happened.

lv_fs_get_size

Get the size in bytes of an open file. The file read/write position will not be affected.

lv_fs_res_t lv_fs_get_size(lv_fs_file_t *file_p, uint32_t *size_res)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from lv_fs_res_t

lv_fs_path_get_size

Get the size in bytes of a file at the given path.

lv_fs_res_t lv_fs_path_get_size(const char *path, uint32_t *size_res)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from lv_fs_res_t

lv_fs_get_letters

Fill a buffer with the letters of existing drivers

char * lv_fs_get_letters(char *buf)

Returns: char * — the buffer

lv_fs_get_ext

Return with the extension of the filename

const char * lv_fs_get_ext(const char *fn)

Returns: const char * — pointer to the beginning extension or empty string if no extension

lv_fs_get_last

Get the last element of a path (e.g. U:/folder/file -> file)

const char * lv_fs_get_last(const char *path)

Returns: const char * — pointer to the beginning of the last element in the path

lv_fs_drv_init

Initialize a file system driver with default values. It is used to ensure all fields have known values and not memory junk. After it you can set the fields.

void lv_fs_drv_init(lv_fs_drv_t *drv)

lv_fs_drv_register

Add a new drive

void lv_fs_drv_register(lv_fs_drv_t *drv)

lv_fs_remove_drive

Remove a drive and call its remove function if available

void lv_fs_remove_drive(char letter)

lv_fs_is_ready

Test if a drive is ready or not. If the ready function was not initialized true will be returned.

bool lv_fs_is_ready(char letter)

Returns: bool — true: drive is ready; false: drive is not ready

lv_fs_open

Open a file

lv_fs_res_t lv_fs_open(lv_fs_file_t *file_p, const char *path, lv_fs_mode_t mode)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from lv_fs_res_t enum

lv_fs_make_path_from_buffer

Create a special object from buffer/ memory address which looks like a file and can be passed as path to lv_fs_open and other functions accepting a path.

For example

//Create a PNG file from t a buffer and use it
lv_fs_path_ex_t p;
lv_fs_make_path_from_buffer(&p, 'A', my_buf, my_buf_size, "png");
lv_image_set_src(image1, &p);

void lv_fs_make_path_from_buffer(lv_fs_path_ex_t *path, char letter, const void *buf, uint32_t size, const char *ext)

lv_fs_close

Close an already opened file

lv_fs_res_t lv_fs_close(lv_fs_file_t *file_p)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from lv_fs_res_t enum

lv_fs_read

Read from a file

lv_fs_res_t lv_fs_read(lv_fs_file_t *file_p, void *buf, uint32_t btr, uint32_t *br)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from lv_fs_res_t enum

lv_fs_write

Write into a file

lv_fs_res_t lv_fs_write(lv_fs_file_t *file_p, const void *buf, uint32_t btw, uint32_t *bw)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from lv_fs_res_t enum

lv_fs_seek

Set the position of the 'cursor' (read write pointer) in a file

lv_fs_res_t lv_fs_seek(lv_fs_file_t *file_p, uint32_t pos, lv_fs_whence_t whence)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from lv_fs_res_t enum

lv_fs_tell

Give the position of the read write pointer

lv_fs_res_t lv_fs_tell(lv_fs_file_t *file_p, uint32_t *pos)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from 'fs_res_t'

lv_fs_load_to_buf

Read the contents of a file at the given path into a buffer.

lv_fs_res_t lv_fs_load_to_buf(void *buf, uint32_t buf_size, const char *path)

Returns: lv_fs_res_t — LV_FS_RES_OK on success, LV_FS_RES_UNKNOWN if fewer than buf_size bytes could be read from the file, or any error from lv_fs_res_t

lv_fs_load_with_alloc

Load a file into a memory buffer.

void * lv_fs_load_with_alloc(const char *path, uint32_t *size)

Returns: void * — a pointer to the loaded file buffer, or NULL if an error occurred

lv_fs_dir_open

Initialize a 'fs_dir_t' variable for directory reading

lv_fs_res_t lv_fs_dir_open(lv_fs_dir_t *rddir_p, const char *path)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from lv_fs_res_t enum

lv_fs_dir_read

Read the next filename form a directory. The name of the directories will begin with '/'

lv_fs_res_t lv_fs_dir_read(lv_fs_dir_t *rddir_p, char *fn, uint32_t fn_len)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from lv_fs_res_t enum

lv_fs_dir_close

Close the directory reading

lv_fs_res_t lv_fs_dir_close(lv_fs_dir_t *rddir_p)

Returns: lv_fs_res_t — LV_FS_RES_OK or any error from lv_fs_res_t enum

lv_fs_up

Step up one level

char * lv_fs_up(char *path)

Returns: char * — the truncated file name

lv_fs_path_join

Concatenate two path components and automatically add/remove a separator as needed. buf, buf_sz, and the return value are analogous to lv_snprintf

int lv_fs_path_join(char *buf, size_t buf_sz, const char *base, const char *end)

Returns: int — the number of characters (not including the null terminator) that would be written to buf, even if buf_sz-1 was smaller