updated message docs #807
updated message docs #807
Conversation
|
|
||
| The following diagram shows how these components relate to each other: | ||
|
|
||
| [source,mermaid] |
There was a problem hiding this comment.
issue: This doesn't render properly. Pull out the mermaid source to a foo.mmd file (then github knows how to render it as well!) and use:
mermaid::foo.mmd[format="svg" config="mermaid.conf"]
elbeno
left a comment
elbeno
left a comment
There was a problem hiding this comment.
Nice work. Only so much I can review right now...
|
|
||
| | `uninitialized` | ||
| | Can remain uninitialized | ||
| | Reserved/padding fields |
There was a problem hiding this comment.
note: A primary use case for uninitialized fields is also overlapping fields so the same bit can be addressed by two fields (e.g. N fields for single bits, one field for the bitset) but the field initializations don't fight.
| | `with_in<V1,V2...>` | ||
| | Set membership matcher | ||
| | Multiple valid values | ||
| |=== |
|
|
||
| **Typical development loop:** | ||
|
|
||
| [source,mermaid] |
There was a problem hiding this comment.
issue: This doesn't render either - extract.
| | Any matcher must match | ||
| | `match::any(m1, m2, m3)` | ||
|
|
||
| | `match::predicate<N>(λ)` |
|
|
||
| | `service<MsgBase>` | ||
| | Linear scan of all callbacks | ||
| | \<10 callbacks, simple dispatch |
There was a problem hiding this comment.
issue: The \< is not rendering properly.
| the following message will not call the callback: | ||
| ===== Automatic simplification | ||
|
|
||
| The matcher system performs compile-time simplification: |
There was a problem hiding this comment.
suggestion: Add a link to the talk.
(Also, not sure this belongs in the message library docs -- there is a match library section.)
| A custom matcher must satisfy the following requirements: | ||
|
|
||
| 1. **Type tag**: `using is_matcher = void;` | ||
| 2. **Match operator**: `operator()(Event const &) const -> bool` |
There was a problem hiding this comment.
issue: -> becomes a ligature
|
|
||
| 1. **Type tag**: `using is_matcher = void;` | ||
| 2. **Match operator**: `operator()(Event const &) const -> bool` | ||
| 3. **Description**: `describe() const` - returns a compile-time string |
There was a problem hiding this comment.
note: "returns a compile-time string" is correct but probably not enough info to actually go on...
|
|
||
| // everything else is the same | ||
| For simple lambda-based matchers, use `match::predicate`: |
There was a problem hiding this comment.
suggestion: Or even better, use field::with_predicate.
| } | ||
|
|
||
| [[nodiscard]] constexpr static auto describe() { | ||
| return stdx::ct_format<"{} in [{}, {}]">( |
There was a problem hiding this comment.
suggestion: Probably all of these naked stdx::ct_format calls should be replaced with STDX_CT_FORMAT which will reduce the noise of things like cts_t wrappers.
|
Awesome feedback, thank you! I know it's a big pr 😅 |
No description provided.