feat(headers): add q function to ease creating Quality values

This commit is contained in:
Sean McArthur
2015-03-01 13:28:22 -08:00
parent 9e0770896b
commit d68773c79f
3 changed files with 9 additions and 5 deletions

View File

@@ -11,11 +11,10 @@ use std::str;
/// Represents a quality used in quality values.
///
/// `Quality` should only be created using the `FromPrimitve` trait methods `from_f32` and
/// `from_f64`, they take a value between 0.0 and 1.0. To create a quality with the value 1.0, the
/// default you can use `let q: Quality = Default::default()`.
/// Can be created with the `q` function.
///
/// # Implementation notes
///
/// The quality value is defined as a number between 0 and 1 with three decimal places. This means
/// there are 1000 possible values. Since floating point numbers are not exact and the smallest
/// floating point data type (`f32`) consumes four bytes, hyper uses an `u16` value to store the
@@ -149,6 +148,11 @@ pub fn qitem<T>(item: T) -> QualityItem<T> {
QualityItem::new(item, Default::default())
}
/// Convenience function to create a `Quality` fromt a float.
pub fn q(f: f32) -> Quality {
FromPrimitive::from_f32(f).expect("q value must be between 0.0 and 1.0")
}
#[cfg(test)]
mod tests {
use std::num::FromPrimitive;