Skip to content

Commit 3ee086f

Browse files
committed
add type aliases to readme
1 parent f696a91 commit 3ee086f

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,13 @@ auto nn2 = nova::non_null(take(std::move(nn1))); // Safe, explicit extraction
5555
| `take(rhs&&)` | Explicitly extract underlying pointer (breaks non-null invariant on rhs) |
5656
| `swap(lhs, rhs)` | ADL-found standard swap |
5757
58+
## Type aliases
59+
60+
| Alias | Equivalent |
61+
|-------|-----------|
62+
| `non_null_unique_ptr<T>` | `non_null<std::unique_ptr<T>>` |
63+
| `non_null_shared_ptr<T>` | `non_null<std::shared_ptr<T>>` |
64+
5865
## Move Safety
5966
6067
Move semantics are **conditionally enabled** based on pointer type:

0 commit comments

Comments
 (0)