Directory struct used in directory operations. More...

#include <shared.h>

Data Fields
uint8_t	dattrs
uint16_t	fdate
uint16_t	ftime
void *	_internal_dp
bool	_internal_has_dir
HAL_ERROR	errno

Detailed Description

Directory struct used in directory operations.

See also: hal_file

This dir struct is used mainly for 3 things

To hold an internal directory pointer. This is created in ffopendir and is used for all of the directory file look ups and pattern matching.
To store information passed back from fdstat.
To hold a return errno by some functions that do not need directory information (mainly ffmkdir).

Anything that has the prefix _internal should NEVER be modified in user code!

Most of the things that apply in this struct apply to the hal_file struct, however in this instance the informational fields are only ever set via fdstat.

Field Documentation

◆ _internal_dp

void* hal_dir::_internal_dp

Internal directory pointer. DO NOT TOUCH THIS!

◆ _internal_has_dir

bool hal_dir::_internal_has_dir

Internal bool to check whether or not a directory is opened to this struct. Same thing as _internal_has_file on hal_file.

◆ dattrs

uint8_t hal_dir::dattrs

Access modifiers. Similarly to hal_file these are not used.

◆ errno

HAL_ERROR hal_dir::errno

Error number returned by the f* functions. This is only set if an actual error occured. See shared.h on how to convert these into strings.

◆ fdate

uint16_t hal_dir::fdate

Date directory was last modified.

◆ ftime

uint16_t hal_dir::ftime

Time directory was last modified.

The documentation for this struct was generated from the following file:

/home/zane/whiskers/code/hal/shared.h

Data Fields