Re: [PATCH v2 1/2] rust: Update PCI binding safety comments and add inline compiler hint

From: Danilo Krummrich
Date: Tue Jul 22 2025 - 07:03:05 EST


On 7/22/25 12:57 PM, Benno Lossin wrote:
On Tue Jul 22, 2025 at 11:51 AM CEST, Danilo Krummrich wrote:
I think they're good, but we're pretty late in the cycle now. That should be
fine though, we can probably take them through the nova tree, or in the worst
case share a tag, if needed.

Given that, it would probably be good to add the Guarantee section on as_raw(),
as proposed by Benno, right away.

@Benno: Any proposal on what this section should say?

At a minimum I'd say "The returned pointer is valid.", but that doesn't
really say for what it's valid... AFAIK you're mostly using this pointer
to pass it to the C side, in that case, how about:

It is used for for FFI calls and to access fields of the underlying
struct pci_dev.

/// # Guarantees
///
/// The returned pointer is valid for reads and writes from the C side for as long as `self` exists.

Maybe we need to change it a bit more, but let's just start with this.