diff --git a/Library-Documentation.md b/Library-Documentation.md index 99e7f18..9c12156 100644 --- a/Library-Documentation.md +++ b/Library-Documentation.md @@ -716,7 +716,37 @@ for (const auto &entry : myMap) { #### BuildMap (basic_partition_map_builder) -High-level interface to build and query partition maps. +Interface to build and query partition maps. + +##### Members +- `Map_t _current_map`: Current map. +- `std::string _workdir`: Search directory. +- `bool _any_generating_error, _map_builded`: Status flags. + +##### Core Methods +- `readDirectory(path)`: Build map from a directory. +- `readDefaultDirectories()`: Build map from default `/dev` entries. +- `getAll()`: Returns the current `Map_t` map. +- `get(name)`: Returns optional info `(size, isLogical)`. +- `getLogicalPartitionList()`, `getPhysicalPartitionList()`, `getPartitionList()`: Return partition lists. +- `getRealLinkPathOf(name)`, `getRealPathOf(name)`: Returns path. +- `hasPartition(name)`, `isLogical(name)`, `sizeOf(name)`, `empty()`: Info queries. +- `copyPartitionsToVector(vec)`, `copyLogicalPartitionsToVector(vec)`, `copyPhysicalPartitionsToVector(vec)`: Copy lists to vectors. + +##### doFor*** Methods +- `doForAllPartitions(func)` +- `doForPhysicalPartitions(func)` +- `doForLogicalPartitions(func)` +- `doForPartitionList(list, func)` + +##### Operators +- `operator*()`: Returns reference to internal map. +- `operator std::vector()`: Returns list as vector. +- `operator int()`: Returns partition count. +- `operator std::string()`: Returns working directory. +- `operator bool()`: Success check. +- `operator!()`: Failure check. +- `operator()(path)`: Build map from path. ##### Example Usage