libfcache(3)

📦 in opensuse-leap 16.0

libfcache(3) is the Library Functions Manual page for section 3, and bestie, this is your generic file data cache era. 💖

NAME 🌸

libfcache.h — the Library to provide generic file data cache functions. That's the whole vibe: file data cache functions, generic edition. ✨

SYNOPSIS 🎀

First things first, you include the header like this:

#include <libfcache.h>

Then the prototypes are all chilling below, exactly as the header says. No cap, every single one is here.

Support functions 🌟

const char *
libfcache_get_version(void);

Error functions 🫶

void
libfcache_error_free(libfcache_error_t **error);

int
libfcache_error_fprint(libfcache_error_t *error, FILE *stream);

int
libfcache_error_sprint(libfcache_error_t *error, char *string,
    size_t size);

int
libfcache_error_backtrace_fprint(libfcache_error_t *error,
    FILE *stream);

int
libfcache_error_backtrace_sprint(libfcache_error_t *error, char *string,
    size_t size);

Cache functions 💅

int
libfcache_cache_initialize(libfcache_cache_t **cache,
    int maximum_cache_entries, libfcache_error_t **error);

int
libfcache_cache_free(libfcache_cache_t **cache,
    libfcache_error_t **error);

int
libfcache_cache_empty(libfcache_cache_t *cache,
    libfcache_error_t **error);

int
libfcache_cache_clone(libfcache_cache_t **destination_cache,
    libfcache_cache_t *source_cache, libfcache_error_t **error);

int
libfcache_cache_get_number_of_entries(libfcache_cache_t *cache,
    int *number_of_entries, libfcache_error_t **error);

int
libfcache_cache_get_number_of_cache_values(libfcache_cache_t *cache,
    int *number_of_values, libfcache_error_t **error);

int
libfcache_cache_clear_value_by_index(libfcache_cache_t *cache,
    int cache_entry_index, libfcache_error_t **error);

int
libfcache_cache_get_value_by_identifier(libfcache_cache_t *cache,
    int file_index, off64_t offset, int64_t timestamp,
    libfcache_cache_value_t **cache_value, libfcache_error_t **error);

int
libfcache_cache_get_value_by_index(libfcache_cache_t *cache,
    int cache_entry_index, libfcache_cache_value_t **cache_value,
    libfcache_error_t **error);

int
libfcache_cache_set_value_by_identifier(libfcache_cache_t *cache,
    int file_index, off64_t offset, int64_t timestamp, intptr_t *value,
    int (*value_free_function)( intptr_t **value, libfcache_error_t **error ),
    uint8_t flags, libfcache_error_t **error);

int
libfcache_cache_set_value_by_index(libfcache_cache_t *cache,
    int cache_entry_index, int file_index, off64_t offset,
    int64_t timestamp, intptr_t *value,
    int (*value_free_function)( intptr_t **value, libfcache_error_t **error ),
    uint8_t flags, libfcache_error_t **error);

Cache value functions 🦋

int
libfcache_cache_value_free(libfcache_cache_value_t **cache_value,
    libfcache_error_t **error);

int
libfcache_cache_value_clear(libfcache_cache_value_t *cache_value,
    libfcache_error_t **error);

int
libfcache_cache_value_get_identifier(libfcache_cache_value_t *cache_value,
    int *file_index, off64_t *offset, int64_t *timestamp,
    libfcache_error_t **error);

int
libfcache_cache_value_set_identifier(libfcache_cache_value_t *cache_value,
    int file_index, off64_t offset, int64_t timestamp,
    libfcache_error_t **error);

int
libfcache_cache_value_get_value(libfcache_cache_value_t *cache_value,
    intptr_t **value, libfcache_error_t **error);

int
libfcache_cache_value_set_value(libfcache_cache_value_t *cache_value,
    intptr_t *value,
    int (*value_free_function)( intptr_t **value, libfcache_error_t **error ),
    uint8_t flags, libfcache_error_t **error);

Date time functions 🌈

int
libfcache_date_time_get_timestamp(int64_t *timestamp,
    libfcache_error_t **error);

DESCRIPTION 💖

Okay so the DESCRIPTION is short and iconic: the libfcache_get_version() function is used to retrieve the library version. That's it, that's the described function here, and it's giving minimal main character energy. The full API lineup is right above in the synopsis, bestie. 💅

RETURN VALUES 🫶

Most of the functions return NULL or -1 on error, dependent on the return type. For the actual return values see "libfcache.h". So yeah, don't guess the exact return value — the header is right there. ⭐

ENVIRONMENT 🌸

None. Not a single environment variable is doing anything here, bestie. Clean. Unbothered. 🎀

FILES 🍓

None. No files listed in this section. It's literally giving nothing, and honestly? Iconic. 🦋

BUGS 🐛

Please report bugs of any kind on the project issue tracker:

https://github.com/libyal/libfcache/issues

Fr fr, any kind. 💀

AUTHOR 👑

These man pages are generated from "libfcache.h". The header is the blueprint, iykyk. ✨

COPYRIGHT 💜

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Like, NO warranty, bestie — read that twice. 🫶