| Wyatt Hepler | f9fb90f | 2020-09-30 18:59:33 -0700 | [diff] [blame] | 1 | .. _module-pw_blob_store: |
| David Rogers | 2d19502 | 2020-07-16 14:07:47 -0700 | [diff] [blame] | 2 | |
| 3 | ------------- |
| 4 | pw_blob_store |
| 5 | ------------- |
| 6 | ``pw_blob_store`` is a storage container library for storing a single blob of |
| 7 | data. Blob_store is a flash-backed persistent storage system with integrated |
| 8 | data integrity checking that serves as a lightweight alternative to a file |
| 9 | system. |
| 10 | |
| 11 | Write and read are only done using the BlobWriter and BlobReader classes. |
| 12 | |
| 13 | Once a blob write is closed, reopening followed by a Discard(), Write(), or |
| 14 | Erase() will discard the previous blob. |
| 15 | |
| 16 | Write blob: |
| 17 | 0) Create BlobWriter instance |
| 18 | 1) BlobWriter::Open(). |
| 19 | 2) Add data using BlobWriter::Write(). |
| 20 | 3) BlobWriter::Close(). |
| 21 | |
| 22 | Read blob: |
| 23 | 0) Create BlobReader instance |
| 24 | 1) BlobReader::Open(). |
| 25 | 2) Read data using BlobReader::Read() or |
| 26 | BlobReader::GetMemoryMappedBlob(). |
| 27 | 3) BlobReader::Close(). |
| 28 | |
| 29 | .. note:: |
| 30 | The documentation for this module is currently incomplete. |