Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fields/message max size #76

Merged
merged 8 commits into from
Mar 27, 2024

Conversation

cmazakas
Copy link
Collaborator

closes #68

@cmazakas cmazakas marked this pull request as ready for review March 19, 2024 21:38
Copy link

codecov bot commented Mar 19, 2024

Codecov Report

Attention: Patch coverage is 95.16129% with 3 lines in your changes are missing coverage. Please review.

Project coverage is 88.22%. Comparing base (39a71bf) to head (65c7ce0).
Report is 2 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop      #76      +/-   ##
===========================================
+ Coverage    88.09%   88.22%   +0.12%     
===========================================
  Files           78       78              
  Lines         4260     4314      +54     
===========================================
+ Hits          3753     3806      +53     
- Misses         507      508       +1     
Files Coverage Δ
include/boost/http_proto/detail/align_up.hpp 100.00% <ø> (ø)
include/boost/http_proto/detail/header.hpp 100.00% <100.00%> (ø)
include/boost/http_proto/fields.hpp 100.00% <ø> (ø)
include/boost/http_proto/fields_base.hpp 100.00% <100.00%> (ø)
include/boost/http_proto/fields_view_base.hpp 100.00% <ø> (ø)
include/boost/http_proto/message_base.hpp 100.00% <100.00%> (ø)
include/boost/http_proto/request.hpp 97.36% <ø> (ø)
include/boost/http_proto/response.hpp 100.00% <ø> (ø)
src/detail/header.cpp 94.01% <100.00%> (+0.01%) ⬆️
src/fields.cpp 100.00% <100.00%> (ø)
... and 3 more

... and 6 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 39a71bf...65c7ce0. Read the comment docs.

BOOST_HTTP_PROTO_DECL
explicit
request(
std::size_t size);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well the parameter needs a javadoc. here and everywhere else

@cmazakas cmazakas force-pushed the feature/fields-base-max-size branch 2 times, most recently from f2e13c1 to 247c0f7 Compare March 22, 2024 19:37
@cmazakas cmazakas force-pushed the feature/fields-base-max-size branch 2 times, most recently from bc9fa35 to 2c416c9 Compare March 25, 2024 22:10
The storage is also used internally to store
instances of an implementation-defined type.
`storage_size` will be aligned accordingly
(currently the alignment requirement is 4).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kind of ugly to use the term storage_size in every consecutive sentence...

Passing an initial storage size of `0` does not
throw and the maximum capacity is set to an
implementation-defined limit observable via
`max_capacity_in_bytes()`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can say @ref max_capacity_in_bytes instead and it will be linked

@param storage_size The initial and final size of
the storage allocated to hold both the serialized
header and instances of a per-field
implementation-defined type.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't have to be verbose and repeat information which was already given in the description. Better to only explain things once, this way if you ever have to change the javadoc you can't forget to edit it everywhere.

@cmazakas cmazakas force-pushed the feature/fields-base-max-size branch from 2c416c9 to 65c7ce0 Compare March 26, 2024 17:28
@cmazakas cmazakas merged commit c7056c4 into cppalliance:develop Mar 27, 2024
53 checks passed
@cmazakas cmazakas deleted the feature/fields-base-max-size branch March 27, 2024 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fields_base allocation behavior
3 participants