Eliminate code duplication and improve documentation: #3924
Conversation
The legacy functions `cdirFirst` and `dirFirst` were mostly identical; the differences were only type-related. The same situation existed with `cdirNext` and `dirNext`. This commit removes the duplicated code by introducing new template functions that abstract away the differences that are present between each pair of functions. This commit also improves the naming of function arguments, helping to elucidate their purpose & use and to make the code self-documenting.
| @@ -45,8 +45,7 @@ class Book_test : public beast::unit_test::suite | |||
| sleOfferDir->key(), | |||
There was a problem hiding this comment.
Clang-format wants to reformat these arguments into a single line. That change will have to happen before we can merge this.
|
|
||
| @deprecated These are legacy function that are considered deprecated | ||
| and will soon be replaced with an iterator-based model | ||
| that is easier to use. You should not use them in new code. |
There was a problem hiding this comment.
I'm not sure we can deprecate something until the replacement it available.
| class N, | ||
| class = std::enable_if_t< | ||
| std::is_same_v<std::remove_cv_t<N>, SLE> && | ||
| std::is_base_of_v<ReadView, V>>> |
There was a problem hiding this comment.
Consider removing the enable_if. Rational: we aren't using enable_if to resolve an overload, we're using it as a type-check and as documentation. I'd probably leave it off entirely and add a comment. This is a detail function only called from this file (it's not on a public interface where clients can call it with weird parameter types and wonder what's wrong). If the wrong types are passed in this file, we'll still get a compile error and quickly figure out why.
If you don't like the comment, as an alternative, consider adding a static_assert. I'd prefer we didn't increase our use of enable_if to cases like this. When we see enable_if I want to think "this is part of an overload set".
The legacy functions
cdirFirstanddirFirstwere mostly identical; the differences were only type-related. The same situation existed withcdirNextanddirNext.This commit removes the duplicated code by introducing new template functions that abstract away the differences that are present between each pair of functions.
This commit also improves the naming of function arguments, helping to elucidate their purpose & use and to make the code self-documenting.