boost/hash2
2
0
Fork 0
mirror of https://github.com/boostorg/hash2.git synced 2026-01-19 04:12:12 +00:00
Code Issues Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Peter Dimov
2025-03-05 15:16:55 +02:00
parent 5af4a71d5e
commit c88adb7e4a
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/hash2/hashing_objects.adoc
View File

@@ -70,7 +70,7 @@ the serialization process in cases where more than one behavior is
possible and desirable. It currently contains the following members:
* `static constexpr endian byte_order; // native, little, or big`
* `using size_type = std::uint64_t; // or std::uint32_t`
* `using size_type = std::uint32_t; // or std::uint64_t`
The `byte_order` member of the flavor affects how scalar {cpp} objects
are serialized into bytes. For example, the `uint32_t` integer `0x01020304`
@@ -94,19 +94,19 @@ There are three predefined flavors, defined in `boost/hash2/flavor.hpp`:
```
struct default_flavor
{
using size_type = std::uint64_t;
using size_type = std::uint32_t;
static constexpr auto byte_order = endian::native;
};
struct little_endian_flavor
{
using size_type = std::uint64_t;
using size_type = std::uint32_t;
static constexpr auto byte_order = endian::little;
};
struct big_endian_flavor
{
using size_type = std::uint64_t;
using size_type = std::uint32_t;
static constexpr auto byte_order = endian::big;
};
```

6
doc/hash2/reference/flavor.adoc
View File

@@ -37,7 +37,7 @@ Flavor types have two members, a type `size_type` and a value `byte_order` of ty
```
struct default_flavor
{
using size_type = std::uint64_t;
using size_type = std::uint32_t;
static constexpr auto byte_order = endian::native;
};
```
@@ -52,7 +52,7 @@ There is rarely a need to use `default_flavor` explicitly, because it's default
```
struct little_endian_flavor
{
using size_type = std::uint64_t;
using size_type = std::uint32_t;
static constexpr auto byte_order = endian::little;
};
```
@@ -66,7 +66,7 @@ However, if the platform is big endian, `hash_append` will be slower because it
```
struct big_endian_flavor
{
using size_type = std::uint64_t;
using size_type = std::uint32_t;
static constexpr auto byte_order = endian::big;
};
```