Blender  V3.3
Classes | Typedefs | Functions
BLI_filereader.h File Reference

Wrapper for reading from various sources (e.g. raw files, compressed files, memory...). More...

#include <sys/types.h>
#include "BLI_compiler_attrs.h"
#include "BLI_utildefines.h"

Go to the source code of this file.

Classes

struct  FileReader
 

Typedefs

typedef ssize_t(* FileReaderReadFn) (struct FileReader *reader, void *buffer, size_t size)
 
typedef off64_t(* FileReaderSeekFn) (struct FileReader *reader, off64_t offset, int whence)
 
typedef void(* FileReaderCloseFn) (struct FileReader *reader)
 
typedef struct FileReader FileReader
 

Functions

FileReaderBLI_filereader_new_file (int filedes) ATTR_WARN_UNUSED_RESULT
 
FileReaderBLI_filereader_new_mmap (int filedes) ATTR_WARN_UNUSED_RESULT
 
FileReaderBLI_filereader_new_memory (const void *data, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
 
FileReaderBLI_filereader_new_zstd (FileReader *base) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
 
FileReaderBLI_filereader_new_gzip (FileReader *base) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
 

Detailed Description

Wrapper for reading from various sources (e.g. raw files, compressed files, memory...).

Definition in file BLI_filereader.h.

Typedef Documentation

◆ FileReader

typedef struct FileReader FileReader

General structure for all #FileReaders, implementations add custom fields at the end.

◆ FileReaderCloseFn

typedef void(* FileReaderCloseFn) (struct FileReader *reader)

Definition at line 33 of file BLI_filereader.h.

◆ FileReaderReadFn

typedef ssize_t(* FileReaderReadFn) (struct FileReader *reader, void *buffer, size_t size)

Definition at line 31 of file BLI_filereader.h.

◆ FileReaderSeekFn

typedef off64_t(* FileReaderSeekFn) (struct FileReader *reader, off64_t offset, int whence)

Definition at line 32 of file BLI_filereader.h.

Function Documentation

◆ BLI_filereader_new_file()

FileReader* BLI_filereader_new_file ( int  filedes)

◆ BLI_filereader_new_gzip()

FileReader* BLI_filereader_new_gzip ( FileReader base)

◆ BLI_filereader_new_memory()

FileReader* BLI_filereader_new_memory ( const void data,
size_t  len 
)

◆ BLI_filereader_new_mmap()

FileReader* BLI_filereader_new_mmap ( int  filedes)

◆ BLI_filereader_new_zstd()

FileReader* BLI_filereader_new_zstd ( FileReader base)