From 1689327817b577d201cb4fadd7c8733f48125f7c Mon Sep 17 00:00:00 2001
From: Joeri Samson <joer@samson-vanassche.be>
Date: Tue, 27 Sep 2022 00:23:28 +0200
Subject: [PATCH] Add inline annotations

Without enabling link time optimization (LTO) there will never be any
inlining across crate boundaries. These methods will be mostly called
from other crates, they are small and used in hot loops.

On a branch of rust-png-reader that was made to use Circular this change
reduced the runtime of one benchmark test from 3 minutes 30 seconds to 1
minute 40 seconds (so over 50%).

(The benchmark is running the example/stats binary on a large (50GB) PGN
file downloaded from the lichess DB)
---
 src/lib.rs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 1b0e13d..339710c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -106,21 +106,25 @@ impl Buffer {
   }
 
   /// returns how much data can be read from the buffer
+  #[inline]
   pub fn available_data(&self) -> usize {
     self.end - self.position
   }
 
   /// returns how much free space is available to write to
+  #[inline]
   pub fn available_space(&self) -> usize {
     self.capacity - self.end
   }
 
   /// returns the underlying vector's size
+  #[inline]
   pub fn capacity(&self) -> usize {
     self.capacity
   }
 
   /// returns true if there is no more data to read
+  #[inline]
   pub fn empty(&self) -> bool {
     self.position == self.end
   }
@@ -130,6 +134,7 @@ impl Buffer {
   /// if the position gets past the buffer's half,
   /// this will call `shift()` to move the remaining data
   /// to the beginning of the buffer
+  #[inline]
   pub fn consume(&mut self, count: usize) -> usize {
     let cnt        = cmp::min(count, self.available_data());
     self.position += cnt;
@@ -144,6 +149,7 @@ impl Buffer {
   ///
   /// This method is similar to `consume()` but will not move data
   /// to the beginning of the buffer
+  #[inline]
   pub fn consume_noshift(&mut self, count: usize) -> usize {
     let cnt        = cmp::min(count, self.available_data());
     self.position += cnt;
@@ -156,6 +162,7 @@ impl Buffer {
   /// if there is not enough available space, this function can call
   /// `shift()` to move the remaining data to the beginning of the
   /// buffer
+  #[inline]
   pub fn fill(&mut self, count: usize) -> usize {
     let cnt   = cmp::min(count, self.available_space());
     self.end += cnt;
@@ -186,24 +193,28 @@ impl Buffer {
   /// assert_eq!(b.position(), 5);
   /// assert_eq!(b.available_data(), 3);
   /// ```
+  #[inline]
   pub fn position(&self) -> usize {
       self.position
   }
 
   /// moves the position and end trackers to the beginning
   /// this function does not modify the data
+  #[inline]
   pub fn reset(&mut self) {
     self.position = 0;
     self.end      = 0;
   }
 
   /// returns a slice with all the available data
+  #[inline]
   pub fn data(&self) -> &[u8] {
     &self.memory[self.position..self.end]
   }
 
   /// returns a mutable slice with all the available space to
   /// write to
+  #[inline]
   pub fn space(&mut self) -> &mut[u8] {
     &mut self.memory[self.end..self.capacity]
   }