1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
// SelfRef - Pain-free self-referential pinned types
// Copyright (C) 2022 Soni L.
// This software is made with love by a queer trans person.
// With help from quinedot
//
// SPDX-License-Identifier: MIT OR Apache-2.0
#![no_std]
#![cfg_attr(feature="nightly", feature(dropck_eyepatch))]
//! An experimental approach to self-referential structs in Rust.
//!
//! This crate provides an alternative approach to self-referential structs,
//! where instead of providing you with a macro or framework where you define
//! a self-referential struct and it handles all of the details for you, we try
//! to expose the abstractions and building blocks for making self-referential
//! structs work well in safe Rust.
//!
//! For example, a [`Holder`] is a safe wrapper around a self-referential
//! struct, providing safe APIs for constructing and manipulating a
//! self-referential struct. However, and unlike other self-referential crates,
//! it does not dictate the backing storage of the struct. The [`Opaque`] trait
//! is used to identify a self-referential struct for use with a [`Holder`] -
//! since Rust does not support higher kinded types (HKTs), this crate uses
//! generic associated types (GATs) as a workaround.
//!
//! To use the crate, first define a self-referential struct in plain Rust:
//!
//! ```rust
//! use std::cell::Cell;
//!
//! // Your self-referential struct.
//! struct MySelfRefStruct<'this> {
//! // Rust uses RAII-like struct construction, as a result this must be
//! // somehow initialized after the struct. We can use an Option in a Cell
//! // for this.
//! this: Cell<Option<&'this MySelfRefStruct<'this>>>,
//! }
//! ```
//!
//! Then, define a type to implement the `Opaque`. This can be done
//! automatically with the `opaque` macro:
//!
//! ```rust
//! # use std::cell::Cell;
//! # // Your self-referential struct.
//! # struct MySelfRefStruct<'this> {
//! # // Rust uses RAII-like struct construction, as a result this must be
//! # // somehow initialized after the struct. We can use an Option in a Cell
//! # // for this.
//! # this: Cell<Option<&'this MySelfRefStruct<'this>>>,
//! # }
//!
//! use selfref::opaque;
//!
//! // A "marker type" that implements `Opaque`.
//! // This follows the "type family" GAT pattern.
//! struct MySelfRefStructKey;
//!
//! opaque! {
//! impl Opaque for MySelfRefStructKey {
//! type Kind<'this> = MySelfRefStruct<'this>;
//! }
//! }
//!
//! // Alternatively, it is possible to implement `Opaque` on, for example,
//! // `MySelfRefStruct<'static>`, but the added lifetime adds verbosity which
//! // may be considered unnecessary/undesired.
//! ```
//!
//! Now you can construct a `Holder` and pick a storage for it. For example,
//! in a `Box`:
//!
//! ```rust
//! # use std::cell::Cell;
//! # // Your self-referential struct.
//! # struct MySelfRefStruct<'this> {
//! # // Rust uses RAII-like struct construction, as a result this must be
//! # // somehow initialized after the struct. We can use an Option in a Cell
//! # // for this.
//! # this: Cell<Option<&'this MySelfRefStruct<'this>>>,
//! # }
//! # use selfref::opaque;
//! # // A "marker type" that implements `Opaque`.
//! # // This follows the "type family" GAT pattern.
//! # struct MySelfRefStructKey;
//! # opaque! {
//! # impl Opaque for MySelfRefStructKey {
//! # type Kind<'this> = MySelfRefStruct<'this>;
//! # }
//! # }
//! # // Alternatively, it is possible to implement `Opaque` on, for example,
//! # // `MySelfRefStruct<'static>`, but the added lifetime adds verbosity which
//! # // may be considered unnecessary/undesired.
//!
//! use selfref::Holder;
//!
//! fn main() {
//! // first, construct the struct
//! let holder = Box::pin(Holder::<'_, MySelfRefStructKey>::new_with(
//! |foo| foo.build({
//! MySelfRefStruct {
//! this: Cell::new(None)
//! }
//! })
//! ));
//!
//! // then, build the self-reference
//! holder.as_ref().operate_in(
//! |this| {
//! this.this.set(Some(this.get_ref()));
//! }
//! );
//! }
//! ```
//!
//! # Examples
//!
//! This is a more complex example borrowing from an external lifetime:
//!
//! ```rust
//! use core::cell::Cell;
//! use core::marker::PhantomData;
//! use core::pin::Pin;
//!
//! use selfref::Holder;
//! use selfref::opaque;
//!
//! struct Foo<'a, 'b: 'a> {
//! foo: Cell<Option<&'a Foo<'a, 'b>>>,
//! t: &'b str,
//! }
//!
//! struct FooKey<'b>(PhantomData<&'b str>);
//! opaque! {
//! impl['b] Opaque for FooKey<'b> {
//! type Kind<'a> = Foo<'a, 'b>;
//! }
//! }
//!
//! fn main() {
//! // a non-'static &str
//! let stack_array: [u8; 5] = *b"hello";
//! let stack_str = core::str::from_utf8(&stack_array).unwrap();
//!
//! // construct the struct
//! let holder = Box::pin(Holder::<'_, FooKey<'_>>::new_with(|foo| {
//! foo.build(Foo {
//! foo: Default::default(),
//! t: stack_str,
//! })
//! }));
//!
//! holder.as_ref().operate_in(|foo| {
//! foo.foo.set(Some(foo.get_ref()));
//! });
//! }
//! ```
//!
//! # Features
//!
//! Due to [PhantomData is unsound](https://github.com/rust-lang/rust/issues/102810)
//! we currently require the following features for `T: ?Sized` support in
//! `selfref::opaque!`:
//!
//! - `alloc` - `selfref::opaque!` for `T: ?Sized` is provided by `Box`.
//! - `nightly` - `selfref::opaque!` for `T: ?Sized` is provided by a *wrapper*
//! around `PhantomData`, which works around the above issue. we call this
//! "PhantomDrop".
//!
//! When enabling both features, `nightly` takes over and we use the wrapper
//! always. This doesn't make a significant difference since the generated UB
//! check is dead code anyway, but `PhantomDrop` doesn't depend on `alloc` and
//! can be used in `no_std` environments.
//!
//! If not using either feature, `T: ?Sized` support requires `unsafe`ly
//! implementing `Opaque`.
//!
//! Note that we do **not** enable any features by default! We assume most
//! folks aren't coming to this crate for its `T: ?Sized` support, so these are
//! the best defaults for crates to depend on. If they do need the `?Sized`
//! support they can just enable one of these (probably `alloc`).
use core::marker::PhantomPinned;
use core::pin::Pin;
use core::mem;
// there's no sound way to dropck T: ?Sized without either alloc or nightly.
//
// so we just have the user opt-in to alloc or nightly as desired.
//
// when using alloc, we use Box<T> for UBCheck.
//
// when using nightly, we use our custom PhantomDrop<T> for UBCheck.
//
// when using neither, we just error on T: ?Sized and require a manual unsafe
// impl of Opaque.
#[cfg(all(feature="alloc", not(feature="nightly")))]
extern crate alloc;
#[cfg(all(feature="alloc", not(feature="nightly")))]
#[doc(hidden)]
pub struct UBCheck<T: ?Sized>(alloc::boxed::Box<T>);
#[cfg(feature="nightly")]
#[doc(hidden)]
pub struct UBCheck<T: ?Sized>(core::marker::PhantomData<T>);
#[cfg(all(not(feature="alloc"), not(feature="nightly")))]
#[doc(hidden)]
pub struct UBCheck<T>(T); // use feature "alloc" or "nightly" for T: ?Sized
#[cfg(feature="nightly")]
// SAFETY: dropck's like a Box<T>, but is no-alloc friendly.
unsafe impl<#[may_dangle] T: ?Sized> Drop for UBCheck<T> {
fn drop(&mut self) {}
}
#[cfg(feature="qcell")]
pub mod srce;
/// An opaqueified self-referential struct "key".
///
/// # Safety
///
/// This is unsafe because there are a bunch of soundness invariants that need
/// to be upheld. The following list is non-exhaustive:
///
/// - `Kind` must not have a `Drop` impl in any "path" that may trace back to
/// the original self-referential type, if said `Drop` impl can observe
/// the self-referential type.
/// - We assume `Kind` has the same layout for any `'a`. This is true as of the
/// time of writing this, and relies on Rust not having lifetime
/// specialization.
///
/// It's recommended to use the `selfref::opaque!` macro instead, which
/// enforces these invariants. For example, this doesn't compile:
///
/// ```rust compile_fail
/// use std::cell::Cell;
/// use selfref::opaque;
///
/// struct Foo<'a> {
/// foo: Cell<Option<&'a Foo<'a>>>,
/// }
///
/// impl<'a> Drop for Foo<'a> {
/// fn drop(&mut self) {
/// }
/// }
///
/// struct FooKey;
/// opaque! {
/// impl Opaque for FooKey {
/// type Kind<'a> = Foo<'a>;
/// }
/// }
/// ```
///
/// But by removing the `Drop` impl, it compiles:
///
/// ```rust
/// use std::cell::Cell;
/// use selfref::opaque;
///
/// struct Foo<'a> {
/// foo: Cell<Option<&'a Foo<'a>>>,
/// }
///
/// //impl<'a> Drop for Foo<'a> {
/// // fn drop(&mut self) {
/// // }
/// //}
///
/// struct FooKey;
/// opaque! {
/// impl Opaque for FooKey {
/// type Kind<'a> = Foo<'a>;
/// }
/// }
/// ```
///
/// # Examples
///
/// ```rust
/// use core::cell::Cell;
///
/// use selfref::Opaque;
///
/// struct Foo<'a> {
/// foo: Cell<Option<&'a Foo<'a>>>,
/// }
///
/// struct FooKey;
/// // SAFETY: Foo has no Drop impl and has the same layout for any 'a.
/// unsafe impl Opaque for FooKey {
/// type Kind<'a> = Foo<'a>;
/// }
/// ```
pub unsafe trait Opaque {
/// The actual self-referential struct.
type Kind<'a>: ?Sized where Self: 'a;
#[doc(hidden)]
fn ub_check() {
}
}
/// Creates an opaqueified self-referential struct "key".
///
/// Safe wrapper around [`Opaque`] that checks the soundness requirements at
/// compile-time.
///
/// There are 2 forms of this macro. The second form accepts type parameters.
///
/// Note that where bounds go after the impl block.
///
/// # Examples
///
/// Simple example:
///
/// ```rust
/// use core::cell::Cell;
///
/// use selfref::opaque;
///
/// struct Foo<'a> {
/// foo: Cell<Option<&'a Foo<'a>>>,
/// }
///
/// struct FooKey;
/// opaque! {
/// impl Opaque for FooKey {
/// type Kind<'a> = Foo<'a>;
/// }
/// }
/// ```
///
/// Type parameters and where bounds:
///
/// ```rust
/// use core::cell::Cell;
/// use core::fmt::Display;
/// use core::marker::PhantomData;
///
/// use selfref::opaque;
///
/// struct Foo<'a, T: Display> {
/// foo: Cell<Option<&'a Foo<'a, T>>>,
/// t: T,
/// }
///
/// struct FooKey<T>(PhantomData<T>);
/// opaque! {
/// impl[T] Opaque for FooKey<T> {
/// type Kind<'a> = Foo<'a, T>;
/// } where T: Display
/// }
/// ```
#[macro_export]
macro_rules! opaque {
(
impl Opaque for $key:ty {
type Kind<$l:lifetime> = $kind:ty;
} $(where $($bounds:tt)*)?
) => {
unsafe impl $crate::Opaque for $key $(where $($bounds)*)? {
type Kind<$l> = $kind where Self: $l;
fn ub_check() {
fn ub_detect_helper(
_f: impl ::core::ops::Fn(
for<$l> fn([&$l (); 0]) -> $crate::UBCheck<$kind>,
for<$l> fn(&$l $crate::UBCheck<$kind>)
)
) $(where $($bounds)*)? {
}
ub_detect_helper(|f, g| {
let x: $crate::UBCheck<Self::Kind<'_>> = f([]);
g(&x);
});
}
}
};
(
impl[$($params:tt)+] Opaque for $key:ty {
type Kind<$l:lifetime> = $kind:ty;
} $(where $($bounds:tt)*)?
) => {
unsafe impl<$($params)+> $crate::Opaque for $key
$(where $($bounds)*)? {
type Kind<$l> = $kind where Self: $l;
fn ub_check() {
fn ub_detect_helper<$($params)+>(
_f: impl ::core::ops::Fn(
for<$l> fn([&$l (); 0]) -> $crate::UBCheck<$kind>,
for<$l> fn(&$l $crate::UBCheck<$kind>)
)
) $(where $($bounds)*)? {
}
ub_detect_helper(|f, g| {
let x: $crate::UBCheck<Self::Kind<'_>> = f([]);
g(&x);
});
}
}
};
}
/// Holds an "opaqueified" `T::Kind`.
///
/// Note the lifetime, `'k`. This can be anything, as long as `T` outlives it.
///
/// # Examples
///
/// ```rust
/// use core::cell::Cell;
///
/// use selfref::Holder;
/// use selfref::opaque;
///
/// #[derive(Default)]
/// struct Foo<'a> {
/// foo: Cell<Option<&'a Foo<'a>>>,
/// }
///
/// struct FooKey;
/// opaque! {
/// impl Opaque for FooKey {
/// type Kind<'a> = Foo<'a>;
/// }
/// }
///
/// fn main() {
/// // We can use a closure here, but we need to give the compiler a hint.
/// let holder = Holder::<'_, FooKey>::new_with(
/// |foo| foo.build(Foo::default())
/// );
/// }
/// ```
pub struct Holder<'k, T> where T: Opaque + 'k {
_pinned: PhantomPinned,
inner: <T as Opaque>::Kind<'k>,
}
/// Helper for creating a [`Holder`].
///
/// This is necessary because closures don't work properly here.
///
/// See [`Holder::new_with`] for examples.
pub struct Builder<'k, T: Opaque + 'k> where T::Kind<'k>: Sized {
inner: Option<T::Kind<'k>>,
}
impl<'k, T: Opaque + 'k> Builder<'k, T> where T::Kind<'k>: Sized {
/// Builds the [`Holder`].
#[inline]
pub fn build(&mut self, t: T::Kind<'k>) {
self.inner = Some(t);
}
}
impl<'k, T> Holder<'k, T> where T: Opaque {
/// Creates a new holder.
///
/// # Examples
///
/// Simple example:
///
/// ```rust
/// use core::cell::Cell;
///
/// use selfref::Holder;
/// use selfref::opaque;
///
/// #[derive(Default)]
/// struct Foo<'a> {
/// foo: Cell<Option<&'a Foo<'a>>>,
/// }
///
/// struct FooKey;
/// opaque! {
/// impl Opaque for FooKey {
/// type Kind<'a> = Foo<'a>;
/// }
/// }
///
/// fn main() {
/// // We can use a closure here, but we need to help the compiler.
/// let holder = Holder::<'_, FooKey>::new_with(
/// |foo| foo.build(Foo::default())
/// );
/// }
/// ```
///
/// Lifetime parameters:
///
/// ```rust
/// use core::cell::Cell;
/// use core::marker::PhantomData;
///
/// use selfref::Holder;
/// use selfref::opaque;
///
/// struct Foo<'a, 'b: 'a> {
/// foo: Cell<Option<&'a Foo<'a, 'b>>>,
/// t: &'b str,
/// }
///
/// struct FooKey<'b>(PhantomData<&'b str>);
/// opaque! {
/// impl['b] Opaque for FooKey<'b> {
/// type Kind<'a> = Foo<'a, 'b>;
/// }
/// }
///
/// fn main() {
/// let stack_array: [u8; 5] = *b"hello";
/// // a non-'static &str
/// let stack_str = core::str::from_utf8(&stack_array).unwrap();
/// let holder = Holder::<'_, FooKey<'_>>::new_with(|foo| {
/// foo.build(Foo {
/// foo: Default::default(),
/// t: stack_str,
/// });
/// });
/// }
/// ```
pub fn new_with<F>(f: F) -> Self
where
F: for<'a> FnOnce(&mut Builder<'a, T>),
T::Kind<'k>: Sized,
{
let mut builder = Builder { inner: None };
f(&mut builder);
Self {
// it is important that the constructor cannot observe 'k!
inner: builder.inner.unwrap(),
_pinned: PhantomPinned
}
}
}
/// Wrapper around a `Pin<&'k T::Kind<'k>>` for implied bounds.
///
/// Derefs to `Pin<&'k T::Kind<'k>>`.
pub struct OperateIn<'k, T> where T: Opaque + 'k {
inner: Pin<&'k T::Kind<'k>>,
}
impl<'k, T> core::ops::Deref for OperateIn<'k, T> where T: Opaque {
type Target = Pin<&'k T::Kind<'k>>;
fn deref(&self) -> &Pin<&'k T::Kind<'k>> {
&self.inner
}
}
impl<'k, T> Holder<'k, T> where T: Opaque {
/// Operates in this (pinned) holder.
///
/// This "unwraps" the value in this holder, and binds its lifetime to a
/// new stack frame.
///
/// # Examples
///
/// Simple example:
///
/// ```rust
/// use core::cell::Cell;
///
/// use selfref::Holder;
/// use selfref::opaque;
///
/// #[derive(Default)]
/// struct Foo<'a> {
/// foo: Cell<Option<&'a Foo<'a>>>,
/// }
///
/// struct FooKey;
/// opaque! {
/// impl Opaque for FooKey {
/// type Kind<'a> = Foo<'a>;
/// }
/// }
///
/// fn main() {
/// let holder = Box::pin(Holder::<'_, FooKey>::new_with(
/// |foo| foo.build(Foo::default())
/// ));
/// // Actually making our Foo refer to itself.
/// holder.as_ref().operate_in(
/// |foo| {
/// foo.foo.set(Some(foo.get_ref()));
/// }
/// );
/// }
/// ```
///
/// With lifetime parameters:
///
/// ```rust
/// use core::cell::Cell;
/// use core::marker::PhantomData;
/// use core::pin::Pin;
///
/// use selfref::Holder;
/// use selfref::opaque;
///
/// struct Foo<'a, 'b: 'a> {
/// foo: Cell<Option<&'a Foo<'a, 'b>>>,
/// t: &'b str,
/// }
///
/// struct FooKey<'b>(PhantomData<&'b str>);
/// opaque! {
/// impl['b] Opaque for FooKey<'b> {
/// type Kind<'a> = Foo<'a, 'b>;
/// }
/// }
///
/// fn main() {
/// let stack_array: [u8; 5] = *b"hello";
/// // a non-'static &str
/// let stack_str = core::str::from_utf8(&stack_array).unwrap();
/// let holder = Box::pin(Holder::<'_, FooKey<'_>>::new_with(|foo| {
/// foo.build(Foo {
/// foo: Default::default(),
/// t: stack_str,
/// });
/// }));
/// // Actually making our Foo refer to itself.
/// holder.as_ref().operate_in(|foo| {
/// foo.foo.set(Some(foo.get_ref()));
/// });
/// }
/// ```
pub fn operate_in<'i, F, R>(self: Pin<&'i Self>, f: F) -> R
where
F: for<'x> FnOnce(OperateIn<'x, T>) -> R
{
/// Converts `Pin<&'a T::Kind<'k>>` to `Pin<&'b T::Kind<'b>>`.
///
/// Not sure why this is called "upcast_dangling" since none of these
/// are actually dangling. But anyway.
unsafe fn upcast_dangling<'a, 'b, 'c, T: Opaque + 'c>(
x: Pin<&'a T::Kind<'c>>,
) -> Pin<&'b T::Kind<'b>>
where T::Kind<'c>: 'a {
mem::transmute(x)
}
f(OperateIn {
inner: unsafe {
upcast_dangling::<'i, 'k, '_, T>
(self.map_unchecked(|self_ref| {
&self_ref.inner
}))
}
})
}
}