From eae53362b224089cd651361336fa707adf113bd3 Mon Sep 17 00:00:00 2001
From: andrews05 <andrew@digerati.co.nz>
Date: Fri, 29 Mar 2024 09:00:03 +1300
Subject: [PATCH] Add comment regarding avoiding panics

---
 src/png/scan_lines.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/png/scan_lines.rs b/src/png/scan_lines.rs
index e865963c..080c211e 100644
--- a/src/png/scan_lines.rs
+++ b/src/png/scan_lines.rs
@@ -27,6 +27,8 @@ impl<'a> Iterator for ScanLines<'a> {
         let (len, pass, num_pixels) = self.iter.next()?;
         debug_assert!(self.raw_data.len() >= len);
         debug_assert!(!self.has_filter || len > 1);
+        // The data length should always be correct here but this check assures
+        // the compiler that it doesn't need to account for a potential panic
         if self.raw_data.len() < len {
             return None;
         }