mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 13:51:05 +00:00
17793d6fc6
Add size reports for both standard buffered blob and deferred writer blob store Change-Id: If8688195f8865c5accc1ec86a9ec57c7b1faecbb Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/31840 Reviewed-by: Alexei Frolov <frolv@google.com> Commit-Queue: David Rogers <davidrogers@google.com>
38 lines
1018 B
ReStructuredText
38 lines
1018 B
ReStructuredText
.. _module-pw_blob_store:
|
|
|
|
-------------
|
|
pw_blob_store
|
|
-------------
|
|
``pw_blob_store`` is a storage container library for storing a single blob of
|
|
data. Blob_store is a flash-backed persistent storage system with integrated
|
|
data integrity checking that serves as a lightweight alternative to a file
|
|
system.
|
|
|
|
Write and read are only done using the BlobWriter and BlobReader classes.
|
|
|
|
Once a blob write is closed, reopening for write followed by a Discard(), Write(), or
|
|
Erase() will discard the previous blob.
|
|
|
|
Write blob:
|
|
0) Create BlobWriter instance
|
|
1) BlobWriter::Open().
|
|
2) Add data using BlobWriter::Write().
|
|
3) BlobWriter::Close().
|
|
|
|
Read blob:
|
|
0) Create BlobReader instance
|
|
1) BlobReader::Open().
|
|
2) Read data using BlobReader::Read() or
|
|
BlobReader::GetMemoryMappedBlob().
|
|
3) BlobReader::Close().
|
|
|
|
Size report
|
|
-----------
|
|
The following size report showcases the memory usage of the blob store.
|
|
|
|
.. include:: blob_size
|
|
|
|
|
|
.. note::
|
|
The documentation for this module is currently incomplete.
|