LDK_PACKAGE_FILE_EXTENSION

#define LDK_PACKAGE_FILE_EXTENSION ".box"

LDK_PACKAGE_PATH_MAX_LENGTH

#define LDK_PACKAGE_PATH_MAX_LENGTH 511u

LDKPackage

typedef struct LDKPackage LDKPackage;

LDKPackageEntry

typedef struct LDKPackageEntry LDKPackageEntry;

LDKPackageWriter

typedef struct LDKPackageWriter LDKPackageWriter;

LDKPackageCompression

typedef enum LDKPackageCompression{
  LDK_PACKAGE_COMPRESSION_NONE=0
}LDKPackageCompression;

ldk_package_path_is_valid

Validate a logical path within a BOX package.

LDK_API bool ldk_package_path_is_valid(const char *path);

ldk_package_file_hash

Compute the FNV-1a hash of a package file.

LDK_API bool ldk_package_file_hash(
 const char *path,
 u64 *out_hash
);

ldk_package_open

Open a BOX package and read its manifest. The reader keeps the package file open until ldk_package_close() is called.

LDK_API LDKPackage * ldk_package_open(const char *path);

ldk_package_close

Close an open package and release its reader resources.

LDK_API void ldk_package_close(LDKPackage *package);

ldk_package_entry_count

Count the package entry.

LDK_API u32 ldk_package_entry_count(const LDKPackage *package);

ldk_package_entry_at

Get the package entry by index.

LDK_API const LDKPackageEntry * ldk_package_entry_at(
 const LDKPackage *package,
 u32 index
);

ldk_package_entry_find

Find the package entry.

LDK_API const LDKPackageEntry * ldk_package_entry_find(
 const LDKPackage *package,
 const char *path
);

ldk_package_entry_get_path

Get the logical path of a package entry.

LDK_API const char * ldk_package_entry_get_path(const LDKPackageEntry *entry);

ldk_package_entry_get_size

Get the uncompressed byte size of an entry.

LDK_API u64 ldk_package_entry_get_size(const LDKPackageEntry *entry);

ldk_package_entry_get_stored_size

Get the stored byte size of an entry.

LDK_API u64 ldk_package_entry_get_stored_size(const LDKPackageEntry *entry);

ldk_package_entry_get_compression

Get the compression mode of a package entry.

LDK_API LDKPackageCompression ldk_package_entry_get_compression(const LDKPackageEntry *entry);

ldk_package_entry_read_at

Read a byte range from an uncompressed package entry. Reaching the end of an entry is not an error. The out_read parameter reports the number of bytes copied.

LDK_API bool ldk_package_entry_read_at(
 const LDKPackage *package,
 const LDKPackageEntry *entry,
 u64 offset,
 void *out_data,
 u64 size,
 u64 *out_read
);

ldk_package_entry_read

Copy an entire uncompressed package entry into caller-provided memory. The destination must have at least ldk_package_entry_get_size(entry) bytes available.

LDK_API bool ldk_package_entry_read(
 LDKPackage *package,
 const LDKPackageEntry *entry,
 void *out_data,
 u64 out_size
);

ldk_package_entry_extract

Extract one package entry to a filesystem path.

LDK_API bool ldk_package_entry_extract(
 LDKPackage *package,
 const LDKPackageEntry *entry,
 const char *destination_path
);

ldk_package_extract_all

Extract every package entry below the requested destination directory.

LDK_API bool ldk_package_extract_all(
 LDKPackage *package,
 const char *destination_directory
);

ldk_package_writer_create

Create the package writer. An unfinished output file is removed if the writer is destroyed before finalization.

LDK_API LDKPackageWriter * ldk_package_writer_create(const char *path);

ldk_package_writer_add_file

Add an existing filesystem file to a package being written.

LDK_API bool ldk_package_writer_add_file(
 LDKPackageWriter *writer,
 const char *source_path,
 const char *package_path,
 LDKPackageCompression compression
);

ldk_package_writer_finalize

Finish writing the package and its manifest.

LDK_API bool ldk_package_writer_finalize(LDKPackageWriter *writer);

ldk_package_writer_destroy

Destroy the package writer.

LDK_API void ldk_package_writer_destroy(LDKPackageWriter *writer);