refactor(metrics/histogram): 🎂 constructor accepts IntoIterator
#243
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cratelyn
changed the title
IntoIteratorIntoIterator
this is a very small, **non-breaking**, alteration to the signature of
`Histogram`'s constructor.
rather than accepting an `impl Iterator`, this commit changes the
parameter of `Histogram::new()` to be an `impl IntoIterator` instead.
this does not affect the existing contract because of the blanket
`impl<I: Iterator> IntoIterator for I` implementation provided by the
standard library.
by accepting `IntoIterator` however, callers providing a collection such
as a `[f64; 5]` array or a `Vec<f64>` vector do not need to invoke
`into_iter()` themselves at the call-site.
```rust
// now, constructing a histogram needn't involve `into_iter()`...
use prometheus_client::metrics::histogram::Histogram;
let histogram = Histogram::new([10.0, 100.0, 1_000.0]);
```
this leans on the same sugar used by `for {}` loops, see the relevant
section of the `std::iter` documentation here:
<https://doc.rust-lang.org/stable/std/iter/index.html#for-loops-and-intoiterator>
no changes are needed within `Histogram::new()` because we already call
`into_iter()` on the provider iterator when appending `f64::MAX` and
collecting the buckets into a `Vec<_>`.
Signed-off-by: katelyn martin <me+cratelyn@katelyn.world>
cratelyn
force-pushed
the
histogram-into-iter
branch
from
9993c64 to
1e216f1
Compare
|
sure thing! i've rebased this on the latest |
mxinden
reviewed
Jan 10, 2025
| @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. | |||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | |||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | |||
|
|
|||
| ## [0.24.0] - unreleased | |||
There was a problem hiding this comment.
Suggested change
| ## [0.24.0] - unreleased | |
| ## [0.23.1] |
Not a breaking change.
Also, if you bump the version in Cargo.toml to v0.24.1 I am happy to cut a patch release right away.
| @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. | |||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | |||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | |||
|
|
|||
| ## [0.24.0] - unreleased | |||
|
|
|||
| - `Histogram::new` now accepts an `IntoIterator` argument, rather than an `Iterator`. | |||
There was a problem hiding this comment.
Suggested change
| - `Histogram::new` now accepts an `IntoIterator` argument, rather than an `Iterator`. | |
| ### Added | |
| - `Histogram::new` now accepts an `IntoIterator` argument, rather than an `Iterator`. |
See keepachangelog format.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this is a very small, non-breaking, alteration to the signature of
Histogram's constructor.rather than accepting an
impl Iterator, this commit changes the parameter ofHistogram::new()to be animpl IntoIteratorinstead. this does not affect the existing contract because of the blanketimpl<I: Iterator> IntoIterator for Iimplementation provided by the standard library.by accepting
IntoIteratorhowever, callers providing a collection such as a[f64; 5]array or aVec<f64>vector do not need to invokeinto_iter()themselves at the call-site.this leans on the same sugar used by
for {}loops, see the relevant section of thestd::iterdocumentation here:https://doc.rust-lang.org/stable/std/iter/index.html#for-loops-and-intoiterator
no changes are needed within
Histogram::new()because we already callinto_iter()on the provider iterator when appendingf64::MAXand collecting the buckets into aVec<_>.