address lints (#24)

Author: danieleades

benches/sherlock.rs

@@ -58,6 +58,7 @@ fn round_trip(input: &[u8]) {
 
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
 
+#[allow(clippy::missing_panics_doc)]
 pub fn criterion_benchmark(c: &mut Criterion) {
     let mut input_string = String::new();
     File::open("./resources/sherlock.txt")

examples/common/mod.rs

@@ -44,7 +44,7 @@ where
 }
 
 #[allow(unused)]
-pub fn round_trip_string<M>(model: M, input: String)
+pub fn round_trip_string<M>(model: M, input: &str)
 where
     M: Model<Symbol = char> + Clone,
 {

examples/fenwick_adaptive.rs

@@ -60,7 +60,7 @@ impl Model for StringModel {
 
     fn update(&mut self, symbol: Option<&Self::Symbol>) {
         let fenwick_symbol = symbol.map(|c| self.alphabet.iter().position(|x| x == c).unwrap());
-        self.fenwick_model.update(fenwick_symbol.as_ref())
+        self.fenwick_model.update(fenwick_symbol.as_ref());
     }
 }
 
@@ -73,5 +73,5 @@ fn main() {
         .read_to_string(&mut input)
         .unwrap();
 
-    common::round_trip_string(model, input);
+    common::round_trip_string(model, &input);
 }

examples/fenwick_context_switching.rs

@@ -58,7 +58,7 @@ impl Model for StringModel {
 
     fn update(&mut self, symbol: Option<&Self::Symbol>) {
         let fenwick_symbol = symbol.map(|c| self.alphabet.iter().position(|x| x == c).unwrap());
-        self.fenwick_model.update(fenwick_symbol.as_ref())
+        self.fenwick_model.update(fenwick_symbol.as_ref());
     }
 }
 
@@ -71,5 +71,5 @@ fn main() {
         .read_to_string(&mut input)
         .unwrap();
 
-    common::round_trip_string(model, input);
+    common::round_trip_string(model, &input);
 }

fenwick-model/src/simple.rs

@@ -13,6 +13,7 @@ pub struct FenwickModel {
     panic_on_saturation: bool,
 }
 
+#[must_use]
 pub struct Builder {
     model: FenwickModel,
 }
@@ -33,13 +34,13 @@ impl Builder {
         self
     }
 
+    #[must_use]
     pub fn build(self) -> FenwickModel {
         self.model
     }
 }
 
 impl FenwickModel {
-    #[must_use]
     pub fn builder(n_symbols: usize, max_denominator: u64) -> Builder {
         Builder::new(n_symbols, max_denominator)
     }

tests/common/mod.rs

@@ -1,15 +1,15 @@
 use arithmetic_coding::{Decoder, Encoder, Model};
 use bitstream_io::{BigEndian, BitReader, BitWrite, BitWriter};
 
-pub fn round_trip<M>(model: M, input: Vec<M::Symbol>)
+pub fn round_trip<M>(model: M, input: &[M::Symbol])
 where
     M: Model + Clone,
     M::Symbol: PartialEq + std::fmt::Debug + Clone,
 {
-    let buffer = encode(model.clone(), input.clone());
+    let buffer = encode(model.clone(), input.to_owned());
     let output = decode(model, &buffer);
 
-    assert_eq!(input, output);
+    assert_eq!(input, output.as_slice());
 }
 
 fn encode<M>(model: M, input: Vec<M::Symbol>) -> Vec<u8>

tests/fixed_length.rs

@@ -49,7 +49,7 @@ impl fixed_length::Model for MyModel {
 
 #[test]
 fn round_trip() {
-    let input = vec![Symbol::A, Symbol::B, Symbol::C];
+    let input = &[Symbol::A, Symbol::B, Symbol::C];
 
     common::round_trip(fixed_length::Wrapper::new(MyModel), input);
 }
@@ -58,7 +58,7 @@ fn round_trip() {
 #[should_panic]
 fn round_trip_fail() {
     // this is too many symbols for this model
-    let input = vec![
+    let input = &[
         Symbol::A,
         Symbol::B,
         Symbol::C,

tests/fuzz.rs

@@ -8,5 +8,5 @@ fn round_trip() {
     let bytes: &[u8] = &[220, 255, 255];
     let input: Vec<usize> = bytes.iter().copied().map(usize::from).collect();
 
-    common::round_trip(model, input);
+    common::round_trip(model, &input);
 }

tests/sherlock.rs

@@ -44,7 +44,7 @@ fn round_trip() {
     let mut file = File::open("./resources/sherlock.txt").unwrap();
     let mut string = String::new();
     file.read_to_string(&mut string).unwrap();
-    let input = string.chars().collect();
+    let input: Vec<_> = string.chars().collect();
 
-    common::round_trip(StringModel, input);
+    common::round_trip(StringModel, &input);
 }