From 2e99ba904e70b21a8b18b7e51ba14b0f703a8a3d Mon Sep 17 00:00:00 2001
From: Raphael Taylor-Davies <r.taylordavies@googlemail.com>
Date: Wed, 3 Jan 2024 14:22:06 +0000
Subject: [PATCH] Docs

---
 object_store/src/client/get.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/object_store/src/client/get.rs b/object_store/src/client/get.rs
index a896cf2745c7..ad4396ccfdc8 100644
--- a/object_store/src/client/get.rs
+++ b/object_store/src/client/get.rs
@@ -58,11 +58,16 @@ impl<T: GetClient> GetClientExt for T {
 }
 
 struct ContentRange {
+    /// The range of the object returned
     range: Range<usize>,
+    /// The total size of the object being requested
     size: usize,
 }
 
 impl ContentRange {
+    /// Parse a content range of the form `bytes <range-start>-<range-end>/<size>`
+    ///
+    /// <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range>
     fn from_str(s: &str) -> Option<Self> {
         let rem = s.trim().strip_prefix("bytes ")?;
         let (range, size) = rem.split_once('/')?;