Object structure.
More...
#include <Object.h>
Object structure.
- Note
- all objects conform to this structure. Only the first word (4 bytes) are required to nagivate the file system. All objects have an 8, 16 or 24-bit size field. Content is always immediately after this field. Reference objects are always 8-bit sized.
◆ Attributes
◆ ID
Object identifier (offset from start of image)
◆ Attribute
Object attributes.
- Note
- these are bit values
Enumerator |
---|
ReadOnly | Object should not be modified or deleted.
|
Archive | Object modified flag.
- Note
- Object has been changed on disk. Typically used by backup applications
|
Encrypted | Object data is encrypted.
This is just a hint. Applications will typically provide additional user metadata to provide any additional information required for decryption.
|
MAX | |
◆ Type
◆ childTableOffset()
uint32_t IFS::FWFS::Object::childTableOffset |
( |
| ) |
const |
|
inline |
◆ childTableSize()
uint32_t IFS::FWFS::Object::childTableSize |
( |
| ) |
const |
|
inline |
◆ contentOffset()
size_t IFS::FWFS::Object::contentOffset |
( |
| ) |
const |
|
inline |
return offset to start of object content
◆ contentSize()
uint32_t IFS::FWFS::Object::contentSize |
( |
| ) |
const |
|
inline |
return size of object content, excluding header and size fields
- Return values
-
- Note
- must check return error code
◆ getRef()
uint32_t IFS::FWFS::Object::getRef |
( |
| ) |
const |
|
inline |
◆ isData()
bool IFS::FWFS::Object::isData |
( |
| ) |
const |
|
inline |
◆ isDir()
bool IFS::FWFS::Object::isDir |
( |
| ) |
const |
|
inline |
◆ isMountPoint()
bool IFS::FWFS::Object::isMountPoint |
( |
| ) |
const |
|
inline |
◆ isNamed()
bool IFS::FWFS::Object::isNamed |
( |
| ) |
const |
|
inline |
◆ isRef()
bool IFS::FWFS::Object::isRef |
( |
| ) |
const |
|
inline |
◆ setContentSize()
void IFS::FWFS::Object::setContentSize |
( |
size_t |
size | ) |
|
|
inline |
◆ setType()
void IFS::FWFS::Object::setType |
( |
Type |
type, |
|
|
bool |
isRef = false |
|
) |
| |
|
inline |
◆ size()
uint32_t IFS::FWFS::Object::size |
( |
| ) |
const |
|
inline |
total size this object occupies in the image
- Return values
-
◆ type()
Type IFS::FWFS::Object::type |
( |
| ) |
const |
|
inline |
◆ @27
◆ _contentSize [1/2]
uint8_t IFS::FWFS::Object::_contentSize |
◆ _contentSize [2/2]
uint16_t IFS::FWFS::Object::_contentSize |
Object size (excluding this header)
◆ _contentSizeHigh
uint8_t IFS::FWFS::Object::_contentSizeHigh |
Allows data up to 16MByte.
◆ ace
struct { ... } IFS::FWFS::Object::ace |
◆ attr
◆ checksum
uint32_t IFS::FWFS::Object::checksum |
◆ compression
◆ data16
struct { ... } IFS::FWFS::Object::data16 |
◆ data24
struct { ... } IFS::FWFS::Object::data24 |
◆ data8
struct { ... } IFS::FWFS::Object::data8 |
◆ end
struct { ... } IFS::FWFS::Object::end |
◆ FWOBT_REF
constexpr uint8_t IFS::FWFS::Object::FWOBT_REF {0x80} |
|
staticconstexpr |
◆ id32
struct { ... } IFS::FWFS::Object::id32 |
◆ index
◆ mtime
◆ named
struct { ... } IFS::FWFS::Object::named |
◆ namelen
◆ objectAttributes
struct { ... } IFS::FWFS::Object::objectAttributes |
◆ packedOffset
uint32_t IFS::FWFS::Object::packedOffset |
◆ ref
struct { ... } IFS::FWFS::Object::ref |
◆ role
◆ tagValue
uint8_t IFS::FWFS::Object::tagValue |
◆ typeData
uint8_t IFS::FWFS::Object::typeData |
◆ userAttribute
struct { ... } IFS::FWFS::Object::userAttribute |
◆ value
uint32_t IFS::FWFS::Object::value |
32-bit identifier, e.g. volume ID
◆ volumeIndex
struct { ... } IFS::FWFS::Object::volumeIndex |
The documentation for this struct was generated from the following file: