All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Benno Lossin" <lossin@kernel.org>
To: "Alexandre Courbot" <acourbot@nvidia.com>,
	"Danilo Krummrich" <dakr@kernel.org>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Alex Gaynor" <alex.gaynor@gmail.com>,
	"Boqun Feng" <boqun.feng@gmail.com>,
	"Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Trevor Gross" <tmgross@umich.edu>
Cc: <rust-for-linux@vger.kernel.org>, <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH v2 1/4] rust: alloc: implement `Borrow` and `BorrowMut` for `Vec`
Date: Sat, 14 Jun 2025 21:19:55 +0200	[thread overview]
Message-ID: <DAMHZIN35QQ9.3N5WSB58J4WG9@kernel.org> (raw)
In-Reply-To: <20250613-borrow_impls-v2-1-6120e1958199@nvidia.com>

On Fri Jun 13, 2025 at 3:46 PM CEST, Alexandre Courbot wrote:
> Implement `Borrow<[T]>` and `BorrowMut<[T]>` for `Vec<T>`. This allows
> `Vec<T>` to be used in generic APIs asking for types implementing those
> traits. `[T; N]` and `&mut [T]` also implement those traits allowing
> users to use either owned, borrowed and heap-owned values.
>
> The implementation leverages `as_slice` and `as_mut_slice`.
>
> Reviewed-by: Alice Ryhl <aliceryhl@google.com>
> Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>

One comment below, with that fixed:

Reviewed-by: Benno Lossin <lossin@kernel.org>

> ---
>  rust/kernel/alloc/kvec.rs | 57 +++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 57 insertions(+)
>
> diff --git a/rust/kernel/alloc/kvec.rs b/rust/kernel/alloc/kvec.rs
> index 1a0dd852a468ccda6ea1b521bc1e7dbc8d7fc79c..3f368d4a67683ac5a0ff87d7df33a3bb640ced59 100644
> --- a/rust/kernel/alloc/kvec.rs
> +++ b/rust/kernel/alloc/kvec.rs
> @@ -8,6 +8,7 @@
>      AllocError, Allocator, Box, Flags,
>  };
>  use core::{
> +    borrow::{Borrow, BorrowMut},
>      fmt,
>      marker::PhantomData,
>      mem::{ManuallyDrop, MaybeUninit},
> @@ -890,6 +891,62 @@ fn deref_mut(&mut self) -> &mut [T] {
>      }
>  }
>  
> +/// Allows `Vec<T>` to be used as a `Borrow<[T]>`.

I personally would vote against this first line description here. I
don't think that it will show up in a summary view of rust doc (since
trait impls don't appear in searches or module overviews). Additionally,
this first sentence seems like this kind of comment:

    // call `foo`:
    foo();

So let's just remove it and directly start with the examples :)

Also for the other cases.

---
Cheers,
Benno

> +///
> +/// # Examples
> +///
> +/// ```
> +/// # use core::borrow::Borrow;
> +/// struct Foo<B: Borrow<[u32]>>(B);
> +///
> +/// // Owned array.
> +/// let foo_array = Foo([1, 2, 3]);
> +///
> +/// // Owned vector.
> +/// let foo_vec = Foo(KVec::from_elem(0, 3, GFP_KERNEL)?);
> +///
> +/// let arr = [1, 2, 3];
> +/// // Borrowed slice from `arr`.
> +/// let foo_borrowed = Foo(&arr[..]);
> +/// # Ok::<(), Error>(())
> +/// ```
> +impl<T, A> Borrow<[T]> for Vec<T, A>
> +where
> +    A: Allocator,
> +{
> +    fn borrow(&self) -> &[T] {
> +        self.as_slice()
> +    }
> +}
> +
> +/// Allows `Vec<T>` to be used as a `BorrowMut<[T]>`.
> +///
> +/// # Examples
> +///
> +/// ```
> +/// # use core::borrow::BorrowMut;
> +/// struct Foo<B: BorrowMut<[u32]>>(B);
> +///
> +/// // Owned array.
> +/// let foo_array = Foo([1, 2, 3]);
> +///
> +/// // Owned vector.
> +/// let foo_vec = Foo(KVec::from_elem(0, 3, GFP_KERNEL)?);
> +///
> +/// let mut arr = [1, 2, 3];
> +/// // Borrowed slice from `arr`.
> +/// let foo_borrowed = Foo(&mut arr[..]);
> +/// # Ok::<(), Error>(())
> +/// ```
> +impl<T, A> BorrowMut<[T]> for Vec<T, A>
> +where
> +    A: Allocator,
> +{
> +    fn borrow_mut(&mut self) -> &mut [T] {
> +        self.as_mut_slice()
> +    }
> +}
> +
>  impl<T: Eq, A> Eq for Vec<T, A> where A: Allocator {}
>  
>  impl<T, I: SliceIndex<[T]>, A> Index<I> for Vec<T, A>


  reply	other threads:[~2025-06-14 19:19 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-13 13:46 [PATCH v2 0/4] rust: a few common Borrow/BorrowMut implementations Alexandre Courbot
2025-06-13 13:46 ` [PATCH v2 1/4] rust: alloc: implement `Borrow` and `BorrowMut` for `Vec` Alexandre Courbot
2025-06-14 19:19   ` Benno Lossin [this message]
2025-06-15 12:36     ` Alexandre Courbot
2025-06-15 13:16       ` Miguel Ojeda
2025-06-15 15:28         ` Benno Lossin
2025-06-13 13:46 ` [PATCH v2 2/4] rust: sync: implement `Borrow` and `BorrowMut` for `Arc` types Alexandre Courbot
2025-06-14 19:20   ` Benno Lossin
2025-06-13 13:46 ` [PATCH v2 3/4] rust: alloc: implement `Borrow` and `BorrowMut` for `KBox` Alexandre Courbot
2025-06-14 19:20   ` Benno Lossin
2025-06-13 13:46 ` [PATCH v2 4/4] rust: str: implement `Borrow` and `BorrowMut` for `CString` Alexandre Courbot
2025-06-14 19:21   ` Benno Lossin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DAMHZIN35QQ9.3N5WSB58J4WG9@kernel.org \
    --to=lossin@kernel.org \
    --cc=a.hindborg@kernel.org \
    --cc=acourbot@nvidia.com \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=dakr@kernel.org \
    --cc=gary@garyguo.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=tmgross@umich.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.