From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 950BE1FF185 for ; Mon, 4 Aug 2025 18:08:29 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id E5C6236391; Mon, 4 Aug 2025 18:09:58 +0200 (CEST) From: Christian Ebner To: pbs-devel@lists.proxmox.com Date: Mon, 4 Aug 2025 18:09:35 +0200 Message-ID: <20250804160937.660470-5-c.ebner@proxmox.com> X-Mailer: git-send-email 2.47.2 In-Reply-To: <20250804160937.660470-1-c.ebner@proxmox.com> References: <20250804160937.660470-1-c.ebner@proxmox.com> MIME-Version: 1.0 X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1754323776924 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.043 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox 4/6] s3 client: add doc comments for response parser helper methods X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" Document the response reader's helper methods to parse the various responses. Signed-off-by: Christian Ebner --- proxmox-s3-client/src/response_reader.rs | 32 ++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/proxmox-s3-client/src/response_reader.rs b/proxmox-s3-client/src/response_reader.rs index fc9519ad..cd3ee98a 100644 --- a/proxmox-s3-client/src/response_reader.rs +++ b/proxmox-s3-client/src/response_reader.rs @@ -186,10 +186,15 @@ pub struct Bucket { } impl ResponseReader { + /// Create a new response reader to parse given response. pub(crate) fn new(response: Response) -> Self { Self { response } } + /// Read and parse the list object v2 response. + /// + /// Returns with error if the bucket cannot be found, an unexpected status code is encountered + /// or the response body cannot be parsed. pub(crate) async fn list_objects_v2_response(self) -> Result { let (parts, body) = self.response.into_parts(); let body = body.collect().await?.to_bytes(); @@ -213,6 +218,10 @@ impl ResponseReader { Ok(response.with_date(date)) } + /// Read and parse the head object response. + /// + /// Returns with error if an unexpected status code is encountered or the response headers or + /// body cannot be parsed. pub(crate) async fn head_object_response(self) -> Result, Error> { let (parts, body) = self.response.into_parts(); let body = body.collect().await?.to_bytes(); @@ -244,6 +253,10 @@ impl ResponseReader { })) } + /// Read and parse the get object response. + /// + /// Returns with error if the object is not accessible, an unexpected status code is encountered + /// or the response headers or body cannot be parsed. pub(crate) async fn get_object_response(self) -> Result, Error> { let (parts, content) = self.response.into_parts(); @@ -274,6 +287,10 @@ impl ResponseReader { })) } + /// Read and parse the put object response. + /// + /// Returns with error on bad request, an unexpected status code is encountered or the response + /// headers or body cannot be parsed. pub(crate) async fn put_object_response(self) -> Result { let (parts, body) = self.response.into_parts(); let body = body.collect().await?.to_bytes(); @@ -301,6 +318,9 @@ impl ResponseReader { Ok(PutObjectResponse::Success(e_tag)) } + /// Read and parse the delete object response. + /// + /// Returns with error if an unexpected status code is encountered. pub(crate) async fn delete_object_response(self) -> Result<(), Error> { let (parts, _body) = self.response.into_parts(); @@ -312,6 +332,10 @@ impl ResponseReader { Ok(()) } + /// Read and parse the delete objects response. + /// + /// Returns with error on bad request, an unexpected status code is encountered or the response + /// body cannot be parsed. pub(crate) async fn delete_objects_response(self) -> Result { let (parts, body) = self.response.into_parts(); let body = body.collect().await?.to_bytes(); @@ -336,6 +360,10 @@ impl ResponseReader { Ok(delete_objects_response) } + /// Read and parse the copy object response. + /// + /// Returns with error if the source object cannot be found or is in-accessible, an unexpected + /// status code is encountered or the response headers or body cannot be parsed. pub(crate) async fn copy_object_response(self) -> Result { let (parts, body) = self.response.into_parts(); let body = body.collect().await?.to_bytes(); @@ -371,6 +399,10 @@ impl ResponseReader { }) } + /// Read and parse the list buckets response. + /// + /// Returns with error if an unexpected status code is encountered or the response body cannot + /// be parsed. pub(crate) async fn list_buckets_response(self) -> Result { let (parts, body) = self.response.into_parts(); let body = body.collect().await?.to_bytes(); -- 2.47.2 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel