Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/windirstat/llfio.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'attic/doc/generated/group_utils.qbk')
-rw-r--r--attic/doc/generated/group_utils.qbk200
1 files changed, 200 insertions, 0 deletions
diff --git a/attic/doc/generated/group_utils.qbk b/attic/doc/generated/group_utils.qbk
new file mode 100644
index 00000000..31fa7fa9
--- /dev/null
+++ b/attic/doc/generated/group_utils.qbk
@@ -0,0 +1,200 @@
+[/============================================================================
+ Boost.AFIO
+
+ Use, modification and distribution is subject to the Boost Software License,
+ Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt)
+=============================================================================/]
+
+
+[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
+[/ Generated from doxy/doxygen_output/xml\group__utils.xml]
+[section:page_sizes page_sizes]
+'''<?dbhtml-include href="disqus_identifiers/page_sizes.html"?>'''
+
+'''<indexterm><primary>page_sizes</primary></indexterm>'''
+Returns the page sizes of this architecture which is useful for calculating direct i/o multiples.
+
+[heading Synopsis]
+``BOOST_AFIO_DECL std::vector<size_t> utils::page_sizes(bool only_actually_available = true)``
+
+[heading Parameters]
+
+[table
+[[Type] [Concept] [Name] [Description] ]
+[[bool] [] [only_actually_available] [Only return page sizes actually available to the user running this process ]]
+]
+
+
+[heading Returns]
+The page sizes of this architecture.
+
+[heading Header]
+`#include <boost/afio/v2/afio.hpp>`
+
+[heading Complexity]Whatever the system API takes (one would hope constant time).
+[heading Exception Model]Any error from the operating system or std::bad_alloc.
+
+
+'''<?dbhtml-include href="disqus_comments.html"?>'''
+[endsect]
+
+[section:file_buffer_default_size file_buffer_default_size]
+'''<?dbhtml-include href="disqus_identifiers/file_buffer_default_size.html"?>'''
+
+'''<indexterm><primary>file_buffer_default_size</primary></indexterm>'''
+Returns a reasonable default size for page\u005fallocator, typically the closest page size from page\u005fsizes() to 1Mb.
+
+[heading Synopsis]
+``size_t utils::file_buffer_default_size()``
+
+[heading Parameters]
+
+[table
+[[Type] [Concept] [Name] [Description] ]
+]
+
+
+[heading Returns]
+A value of a TLB large page size close to 1Mb.
+
+[heading Header]
+`#include <boost/afio/v2/afio.hpp>`
+
+[heading Complexity]Whatever the system API takes (one would hope constant time).
+[heading Exception Model]Any error from the operating system or std::bad_alloc.
+
+
+'''<?dbhtml-include href="disqus_comments.html"?>'''
+[endsect]
+
+[section:random_fill random_fill]
+'''<?dbhtml-include href="disqus_identifiers/random_fill.html"?>'''
+
+'''<indexterm><primary>random_fill</primary></indexterm>'''
+Fills the buffer supplied with cryptographically strong randomness. Uses the OS kernel API.
+
+[heading Synopsis]
+``BOOST_AFIO_DECL void utils::random_fill(char * buffer, size_t bytes)``
+
+[heading Parameters]
+
+[table
+[[Type] [Concept] [Name] [Description] ]
+[[char *] [] [buffer] [A buffer to fill ]]
+[[size_t] [] [bytes] [How many bytes to fill]]
+]
+
+
+[heading Header]
+`#include <boost/afio/v2/afio.hpp>`
+
+[heading Complexity]Whatever the system API takes.
+[heading Exception Model]Any error from the operating system.
+
+
+'''<?dbhtml-include href="disqus_comments.html"?>'''
+[endsect]
+
+[section:to_hex_string to_hex_string]
+'''<?dbhtml-include href="disqus_identifiers/to_hex_string.html"?>'''
+
+'''<indexterm><primary>to_hex_string</primary></indexterm>'''
+Converts a number to a hex string. Out buffer can be same as in buffer.
+
+[heading Description]
+Note that the character range used is a 16 item table of:
+
+0123456789abcdef
+
+This lets one pack one byte of input into two bytes of output.
+
+[heading Synopsis]
+``size_t utils::to_hex_string(char * out, size_t outlen, const char * _in,
+ size_t inlen)``
+
+[heading Parameters]
+
+[table
+[[Type] [Concept] [Name] [Description] ]
+[[char *] [] [out] []]
+[[size_t] [] [outlen] []]
+[[const char *] [] [_in] []]
+[[size_t] [] [inlen] []]
+]
+
+
+[heading Header]
+`#include <boost/afio/v2/afio.hpp>`
+
+[heading Complexity]O(N) where N is the length of the number.
+[heading Exception Model]Throws exception if output buffer is too small for input.
+
+
+'''<?dbhtml-include href="disqus_comments.html"?>'''
+[endsect]
+
+[section:from_hex_string from_hex_string]
+'''<?dbhtml-include href="disqus_identifiers/from_hex_string.html"?>'''
+
+'''<indexterm><primary>from_hex_string</primary></indexterm>'''
+Converts a hex string to a number. Out buffer can be same as in buffer.
+
+[heading Description]
+Note that this routine is about 43% slower than to\u005fhex\u005fstring(), half of which is due to input validation.
+
+[heading Synopsis]
+``size_t utils::from_hex_string(char * out, size_t outlen, const char * in,
+ size_t inlen)``
+
+[heading Parameters]
+
+[table
+[[Type] [Concept] [Name] [Description] ]
+[[char *] [] [out] []]
+[[size_t] [] [outlen] []]
+[[const char *] [] [in] []]
+[[size_t] [] [inlen] []]
+]
+
+
+[heading Header]
+`#include <boost/afio/v2/afio.hpp>`
+
+[heading Complexity]O(N) where N is the length of the string.
+[heading Exception Model]Throws exception if output buffer is too small for input or input size is not multiple of two.
+
+
+'''<?dbhtml-include href="disqus_comments.html"?>'''
+[endsect]
+
+[section:random_string random_string]
+'''<?dbhtml-include href="disqus_identifiers/random_string.html"?>'''
+
+'''<indexterm><primary>random_string</primary></indexterm>'''
+Returns a cryptographically random string capable of being used as a filename. Essentially random\u005ffill() + to\u005fhex\u005fstring().
+
+[heading Synopsis]
+``std::string utils::random_string(size_t randomlen)``
+
+[heading Parameters]
+
+[table
+[[Type] [Concept] [Name] [Description] ]
+[[size_t] [] [randomlen] [The number of bytes of randomness to use for the string. ]]
+]
+
+
+[heading Returns]
+A string representing the randomness at a 2x ratio, so if 32 bytes were requested, this string would be 64 bytes long.
+
+[heading Header]
+`#include <boost/afio/v2/afio.hpp>`
+
+[heading Complexity]Whatever the system API takes.
+[heading Exception Model]Any error from the operating system.
+
+
+'''<?dbhtml-include href="disqus_comments.html"?>'''
+[endsect]
+