From f10914a662b00ac154752630548682122f2acb4c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ya=C4=9F=C4=B1z=20Zengin?= Date: Sun, 7 Sep 2025 11:45:38 +0300 Subject: [PATCH] Updated Library Documentation (markdown) --- Library-Documentation.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Library-Documentation.md b/Library-Documentation.md index c1ba586..dff77df 100644 --- a/Library-Documentation.md +++ b/Library-Documentation.md @@ -357,6 +357,7 @@ int main(int argc, char** argv) { * `std::string pathBasename(std::string_view entry)` - Get the filename part of given path. * `std::string pathDirname(std::string_view entry)` - Get the directory part of given path. * `uint64_t getRandomOffset(uint64_t size, uint64_t bufferSize)` - Get random offset depending on size and bufferSize. +* `std::string convertTo(uint64_t size, const std::string &multiple)` - Convert size to multiple. Returns result as string. --- @@ -487,10 +488,19 @@ for (const auto &entry : myMap) { - `find(name)`, `find_(name)`: Check existence. - `size()`, `empty()`: Map size and empty check. +##### Operators +- `operator std::vector()`: Returns list as vector. +- `operator int()`: Returns partition count. +- `operator bool()`: Success check. +- `operator!()`: Failure check. +- `operator()(path)`: Build map from path. +- `Info operator[](index)`: Return the information of the section in the input index in the Info structure. +- `BasicInf operator[](name)`: Return the input section name information in the BasicInfo structure. + --- #### BuildMap -Interface to build and query partition maps. `BuildMap` is alias of `basic_partition_map_builder| +Interface to build and query partition maps. `BuildMap` is alias of `basic_partition_map_builder`. ##### Members - `Map_t _current_map`: Current map. @@ -521,6 +531,8 @@ Interface to build and query partition maps. `BuildMap` is alias of `basic_parti - `operator bool()`: Success check. - `operator!()`: Failure check. - `operator()(path)`: Build map from path. +- `Info operator[](index)`: Return the information of the section in the input index in the Info structure. +- `BasicInf operator[](name)`: Return the input section name information in the BasicInfo structure. ##### Example Usage