Commit d6dbca35 authored by Benno Lossin's avatar Benno Lossin Committed by Miguel Ojeda

rust: sync: change error type of constructor functions

Change the error type of the constructors of `Arc` and `UniqueArc` to be
`AllocError` instead of `Error`. This makes the API more clear as to
what can go wrong when calling `try_new` or its variants.
Signed-off-by: default avatarBenno Lossin <benno.lossin@proton.me>
Reviewed-by: default avatarAndreas Hindborg <a.hindborg@samsung.com>
Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Reviewed-by: default avatarGary Guo <gary@garyguo.net>
Link: https://lore.kernel.org/r/20230408122429.1103522-4-y86-dev@protonmail.comSigned-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 70a21e54
...@@ -17,11 +17,11 @@ ...@@ -17,11 +17,11 @@
use crate::{ use crate::{
bindings, bindings,
error::Result,
types::{ForeignOwnable, Opaque}, types::{ForeignOwnable, Opaque},
}; };
use alloc::boxed::Box; use alloc::boxed::Box;
use core::{ use core::{
alloc::AllocError,
fmt, fmt,
marker::{PhantomData, Unsize}, marker::{PhantomData, Unsize},
mem::{ManuallyDrop, MaybeUninit}, mem::{ManuallyDrop, MaybeUninit},
...@@ -152,7 +152,7 @@ unsafe impl<T: ?Sized + Sync + Send> Sync for Arc<T> {} ...@@ -152,7 +152,7 @@ unsafe impl<T: ?Sized + Sync + Send> Sync for Arc<T> {}
impl<T> Arc<T> { impl<T> Arc<T> {
/// Constructs a new reference counted instance of `T`. /// Constructs a new reference counted instance of `T`.
pub fn try_new(contents: T) -> Result<Self> { pub fn try_new(contents: T) -> Result<Self, AllocError> {
// INVARIANT: The refcount is initialised to a non-zero value. // INVARIANT: The refcount is initialised to a non-zero value.
let value = ArcInner { let value = ArcInner {
// SAFETY: There are no safety requirements for this FFI call. // SAFETY: There are no safety requirements for this FFI call.
...@@ -472,7 +472,7 @@ pub struct UniqueArc<T: ?Sized> { ...@@ -472,7 +472,7 @@ pub struct UniqueArc<T: ?Sized> {
impl<T> UniqueArc<T> { impl<T> UniqueArc<T> {
/// Tries to allocate a new [`UniqueArc`] instance. /// Tries to allocate a new [`UniqueArc`] instance.
pub fn try_new(value: T) -> Result<Self> { pub fn try_new(value: T) -> Result<Self, AllocError> {
Ok(Self { Ok(Self {
// INVARIANT: The newly-created object has a ref-count of 1. // INVARIANT: The newly-created object has a ref-count of 1.
inner: Arc::try_new(value)?, inner: Arc::try_new(value)?,
...@@ -480,7 +480,7 @@ pub fn try_new(value: T) -> Result<Self> { ...@@ -480,7 +480,7 @@ pub fn try_new(value: T) -> Result<Self> {
} }
/// Tries to allocate a new [`UniqueArc`] instance whose contents are not initialised yet. /// Tries to allocate a new [`UniqueArc`] instance whose contents are not initialised yet.
pub fn try_new_uninit() -> Result<UniqueArc<MaybeUninit<T>>> { pub fn try_new_uninit() -> Result<UniqueArc<MaybeUninit<T>>, AllocError> {
Ok(UniqueArc::<MaybeUninit<T>> { Ok(UniqueArc::<MaybeUninit<T>> {
// INVARIANT: The newly-created object has a ref-count of 1. // INVARIANT: The newly-created object has a ref-count of 1.
inner: Arc::try_new(MaybeUninit::uninit())?, inner: Arc::try_new(MaybeUninit::uninit())?,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment