From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4F301EE4995 for ; Wed, 11 Sep 2024 11:32:36 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 4F677940028; Wed, 11 Sep 2024 07:32:35 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 4A70B940021; Wed, 11 Sep 2024 07:32:35 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 349CA940028; Wed, 11 Sep 2024 07:32:35 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id 15D87940021 for ; Wed, 11 Sep 2024 07:32:35 -0400 (EDT) Received: from smtpin09.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id 755D91C439C for ; Wed, 11 Sep 2024 11:32:34 +0000 (UTC) X-FDA: 82552244628.09.01A3D24 Received: from nyc.source.kernel.org (nyc.source.kernel.org [147.75.193.91]) by imf22.hostedemail.com (Postfix) with ESMTP id D02C6C000B for ; Wed, 11 Sep 2024 11:32:31 +0000 (UTC) Authentication-Results: imf22.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=U8NEgo5v; spf=pass (imf22.hostedemail.com: domain of dakr@kernel.org designates 147.75.193.91 as permitted sender) smtp.mailfrom=dakr@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1726054299; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=lhS/tonvhNWgyqw6MKLGoxpFJ5jbObYi9SxpLIHZm8Q=; b=qfN1w3gwpPtWzbwweh0J9vrTcFVUSemI3A7JkWfJiCGs3xXxEln1kQqCFKscLhsv62uvaY psBZ71SeKLcsRbUcknhLAIC9lQFq1Rpwe0ENciYFBxYRfGiiNwrIe5/Z56ZTgoUUUiWHgH 2w6UW5COdkD5NlRGQH8/QdHSQsdr9t8= ARC-Authentication-Results: i=1; imf22.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=U8NEgo5v; spf=pass (imf22.hostedemail.com: domain of dakr@kernel.org designates 147.75.193.91 as permitted sender) smtp.mailfrom=dakr@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1726054299; a=rsa-sha256; cv=none; b=sBPoJwMnNNh7g4R5SzuRqjWrF4tYMXJe1gVw34W22oMIJd1PRnZX7HQrHn3SS9/S+d+nnc R4ienzlSwDF2lwy9oEVT5kXDF0ZewS5cxsPNxLhBsOXTIZ4LNLpMlLLDJPJsXcalKPT4rX VFHaRptW4H1YcsNd3udFd6ugY3udR9E= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by nyc.source.kernel.org (Postfix) with ESMTP id 52E19A449B3; Wed, 11 Sep 2024 11:32:23 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id C2591C4CEC5; Wed, 11 Sep 2024 11:32:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1726054350; bh=wZreKAiqXdRRnDPLI28qQmvvixc/AOTCYGxtJBYNZWc=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=U8NEgo5v03iv7sMsrNvEVAi4+rcivnwhfgoqAl5WNNgmpZ6OOMeHRAcn4hWSkQazj uoFwwNbLZihasWRa6SeBD9fivIaCamoypbUb/2Vy7KIxwRQXAMG1IdDtsl+jj0F3P8 LlLZZRYMe8fbsuDgicMDoHWu45Dr+E4fGiyghbIDmiXODrxJgOCGo1hOugoFartzvE 48dz5S0kGjwCm9r4wcgov42A2tIjXofXz8k9fi7Pr1RvyC8wTO1ozhyfG5h/YYgM5g hDT82GfqHbp3Z7g4pk9BkA9riyyEk+6B/CM05alm2qv3HQ1RrwIPFT3hKEmS9UtO5F cUCSO/ld3/sJg== Date: Wed, 11 Sep 2024 13:32:23 +0200 From: Danilo Krummrich To: Benno Lossin Cc: ojeda@kernel.org, alex.gaynor@gmail.com, wedsonaf@gmail.com, boqun.feng@gmail.com, gary@garyguo.net, bjorn3_gh@protonmail.com, a.hindborg@samsung.com, aliceryhl@google.com, akpm@linux-foundation.org, daniel.almeida@collabora.com, faith.ekstrand@collabora.com, boris.brezillon@collabora.com, lina@asahilina.net, mcanal@igalia.com, zhiw@nvidia.com, cjia@nvidia.com, jhubbard@nvidia.com, airlied@redhat.com, ajanulgu@redhat.com, lyude@redhat.com, linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-mm@kvack.org Subject: Re: [PATCH v6 14/26] rust: alloc: implement `IntoIterator` for `Vec` Message-ID: References: <20240816001216.26575-1-dakr@kernel.org> <20240816001216.26575-15-dakr@kernel.org> <308d40dd-105b-4ebf-ba70-585a97d66928@proton.me> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: X-Rspamd-Server: rspam03 X-Rspam-User: X-Rspamd-Queue-Id: D02C6C000B X-Stat-Signature: 41pm8r64zkp8z85hzjgi1zsd4abwnkzh X-HE-Tag: 1726054351-700361 X-HE-Meta: U2FsdGVkX1/YOen6722jgLKcz2TRbDz2/7+AESZ1AoMo70LNddBSro+OWg8BK3WcrPtra+Y4sIKOUb397hY58Jr1iHw7AW9IhjiKavZAmyxB9QWJF7psM6dTtlD83f71XvhCe4bFzb5TDcsLG1YfnJEeesaSXzOxnwKNoHkGIt2/646i2yg/aV00qLACb/GvS4G29iJwgI6GTxxFppJB7ovMSU1mUd/IDDTjEKSk4FLj1ZT+O9QEYIedqW2u35UOxfkFzeZr4Cn9fbsarIaCbWKTwTowbAuk7ur82IPhc4zSK/cY9WyJlw4COturAf7ZSKzADx01W2JeOtorUCTKSRuUcclKk5yiivS6jnR1Iq0bi8qj59GLdZkCEc/nB7clhI6rPSulz3L7B7paDakvUXq6t12+epqbVW9w+8C/2P6bHxveZ0VXrgBVfanZXVm35YIvHRaaMFV5J6fbPWnp8aZecYY8lkrEUeqmb0l+Fllu+3IFhCCtXpPVW5Zz9lNXh2tOLEo4+XJSnHWQNJhziTnXKfgdn9W6ug/7TUvOlf30dqk1FUY8fWqOXhvQhEJl+QUEjfySf6PxRuZJL/5k/6j8SNimAhqR9WOSmA6lLvh0pWSXHdEIbQYT6xMzCDDYE3FLwq4mmvbsYYyTVVt0YPDiCbA5ecJmrZWaz9UtA8MbB0XnsJfilX+UD09LNYJpDSK6v7r0RrFkUHfpRu0xAYpuV1QZO4hA4uZq236tvoCbrjb+RrI+u2yyUpG/jJaRku6K82jxdXbVQx8GMEUTzLeeZ8QNP16WCab/OE4BaJzzJ5tdZkCjXCYiPz7DbFUNFv/08o5NiJfC2f/UrgkfMet3GpBbkAUWaymB35bphGSqnQ/CLYzsEwxTUtp4ClEcEjz1bi+xFMou0CE2vvCL6dTniOFHjab3UUUAYgoUgvFOQmX+DA8VAsCw6YOAtOSx5/gQIKuXhRkUQzme9qR PcM4lfgu c7xLe5unExKr6ErZq8utl0iTHTgaFsMlEcElJPA9Xsi4M5itQFVI0USFLux81uoGfrimwWtvc6am8GceycDR6QBAMGsdMk3GFfJyINWYQ8pbxid2LwncBCv1k9rbTpdh+0EBd/+/0J1Rx+zY4WPN6BUrQZM3awfuWBzkDAEnYuaRZr71AhJ/83241+5F86SRGVIyKl8m+qxfOuOmDL/LKXylWxjEFsaCNsCE+8PrxbYvCkPB4AbvauSoaMIuWbH3IE1fSs8A8mE2mrBqD5N24fJfNR7QyEAtq0QbA8fcZa3OI9JQwqGJyYcZwy1zeICBTlizsf6+Kx6QvYl0= X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: On Wed, Sep 11, 2024 at 08:52:03AM +0000, Benno Lossin wrote: > On 11.09.24 01:39, Danilo Krummrich wrote: > > On Tue, Sep 10, 2024 at 08:04:27PM +0000, Benno Lossin wrote: > >> On 16.08.24 02:10, Danilo Krummrich wrote: > >>> +/// [`IntoIterator`] trait). > >>> +/// > >>> +/// # Examples > >>> +/// > >>> +/// ``` > >>> +/// let v = kernel::kvec![0, 1, 2]?; > >>> +/// let iter = v.into_iter(); > >>> +/// > >>> +/// # Ok::<(), Error>(()) > >>> +/// ``` > >>> +pub struct IntoIter { > >>> + ptr: *mut T, > >>> + buf: NonNull, > >> > >> No invariants for these two fields? > > > > Suggestions? > > When determining the invariants, I look at the places where you would > want to use them, ie the `SAFETY` comments that use these fields: > - for `buf` you only use it to free the backing allocation, so you only > need that it has been allocated by `A` if `cap != 0`. > - for `ptr` you need that it is valid for reads for `size_of::() * > length` bytes. > > So I would put those two things into invariants. > > >>> + len: usize, > >>> + cap: usize, > >>> + _p: PhantomData, > >>> +} > >>> + > >>> +impl IntoIter > >>> +where > >>> + A: Allocator, > >>> +{ > >>> + fn as_raw_mut_slice(&mut self) -> *mut [T] { > >>> + ptr::slice_from_raw_parts_mut(self.ptr, self.len) > >>> + } > >>> +} > >>> + > >>> +impl Iterator for IntoIter > >>> +where > >>> + A: Allocator, > >>> +{ > >>> + type Item = T; > >>> + > >>> + /// # Examples > >>> + /// > >>> + /// ``` > >>> + /// let v = kernel::kvec![1, 2, 3]?; > >>> + /// let mut it = v.into_iter(); > >>> + /// > >>> + /// assert_eq!(it.next(), Some(1)); > >>> + /// assert_eq!(it.next(), Some(2)); > >>> + /// assert_eq!(it.next(), Some(3)); > >>> + /// assert_eq!(it.next(), None); > >>> + /// > >>> + /// # Ok::<(), Error>(()) > >>> + /// ``` > >> > >> AFAIK documentation on functions in trait implementations won't show up > >> in rustdoc (I just checked this). So I would remove it. > > > > They don't, but the KUnit tests are still executed. :) > > Oh I see, then may I suggest moving them to the module documentation or > put them onto `Vec`, that way people can also read them :) Hm, I'd rather keep them close on the functions they're testing. Those examples probably don't have a huge documentation purpose. As you've said, the trait is documented already and has examples. > > --- > Cheers, > Benno > >