ChibiOS/HAL  6.1.0
hal_files.h File Reference

Data files. More...

Go to the source code of this file.

Data Structures

struct  FileStreamVMT
 FileStream virtual methods table. More...
 
struct  FileStream
 Base file stream class. More...
 

Macros

#define _file_stream_methods
 FileStream specific methods. More...
 
#define _file_stream_data   _base_sequential_stream_data
 FileStream specific data. More...
 
Files return codes
#define FILE_OK   STM_OK
 No error return code. More...
 
#define FILE_ERROR   STM_TIMEOUT
 Error code from the file stream methods. More...
 
#define FILE_EOF   STM_RESET
 End-of-file condition for file get/put methods. More...
 
Macro Functions (FileStream)
#define fileStreamWrite(ip, bp, n)   streamWrite(ip, bp, n)
 File stream write. More...
 
#define fileStreamRead(ip, bp, n)   streamRead(ip, bp, n)
 File stream read. More...
 
#define fileStreamPut(ip, b)   streamPut(ip, b)
 File stream blocking byte write. More...
 
#define fileStreamGet(ip)   streamGet(ip)
 File stream blocking byte read. More...
 
#define fileStreamClose(ip)   ((ip)->vmt->close(ip))
 File Stream close. More...
 
#define fileStreamGetError(ip)   ((ip)->vmt->geterror(ip))
 Returns an implementation dependent error code. More...
 
#define fileStreamGetSize(ip)   ((ip)->vmt->getsize(ip))
 Returns the current file size. More...
 
#define fileStreamGetPosition(ip)   ((ip)->vmt->getposition(ip))
 Returns the current file pointer position. More...
 
#define fileStreamSeek(ip, offset)   ((ip)->vmt->lseek(ip, offset))
 Moves the file current pointer to an absolute position. More...
 

Typedefs

typedef uint32_t fileoffset_t
 File offset type. More...
 

Detailed Description

Data files.

This header defines abstract interfaces useful to access generic data files in a standardized way.

Definition in file hal_files.h.