From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 386A163C6A for ; Fri, 17 Jul 2020 08:35:24 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 3021819B78 for ; Fri, 17 Jul 2020 08:34:54 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id E30F619B56 for ; Fri, 17 Jul 2020 08:34:52 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id A73FE40982 for ; Fri, 17 Jul 2020 08:34:52 +0200 (CEST) From: Dominik Csapak To: pbs-devel@lists.proxmox.com Date: Fri, 17 Jul 2020 08:34:51 +0200 Message-Id: <20200717063451.19207-4-d.csapak@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200717063451.19207-1-d.csapak@proxmox.com> References: <20200717063451.19207-1-d.csapak@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.009 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment KAM_LAZY_DOMAIN_SECURITY 1 Sending domain does not have any anti-forgery methods NO_DNS_FOR_FROM 0.379 Envelope sender has no MX or A DNS records RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_NONE 0.001 SPF: sender does not publish an SPF Record Subject: [pbs-devel] [PATCH proxmox 4/4] proxmox/tools/byte_buffer: improve read_from example 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: , X-List-Received-Date: Fri, 17 Jul 2020 06:35:24 -0000 'norun' was not a valid attribute, so cargo doc ignored it completely instead, write a proper example that can be compiled Signed-off-by: Dominik Csapak --- proxmox/src/tools/byte_buffer.rs | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/proxmox/src/tools/byte_buffer.rs b/proxmox/src/tools/byte_buffer.rs index f01a6dd..24aec11 100644 --- a/proxmox/src/tools/byte_buffer.rs +++ b/proxmox/src/tools/byte_buffer.rs @@ -154,14 +154,15 @@ impl ByteBuffer { /// free space in the buffer) and updates its size accordingly. /// /// Example: - /// ```norun - /// // create some reader - /// let reader = ...; - /// - /// let mut buf = ByteBuffer::new(); - /// let res = buf.read_from(reader); - /// // do something with the buffer - /// ... + /// ``` + /// # use std::io; + /// # use proxmox::tools::byte_buffer::ByteBuffer; + /// fn code(mut reader: R) -> io::Result<()> { + /// let mut buf = ByteBuffer::new(); + /// let res = buf.read_from(&mut reader)?; + /// // do something with the buffer + /// Ok(()) + /// } /// ``` pub fn read_from(&mut self, input: &mut T) -> Result { let amount = input.read(self.get_free_mut_slice())?; -- 2.20.1