pub trait WriteApi: GuardedTarget {
type WriteGuard<'a>: DerefMut<Target = Self::Target>
where Self: 'a;
// Required method
fn write(&mut self) -> Self::WriteGuard<'_>;
}Expand description
Provides a mutable part of the RwApi interface.
§Example
use std::ops::Deref;
use parking_lot::RwLock;
use read_write_api::{RwApi, RwApiWrapper, RwApiWrapperOwned, WriteApi};
fn do_something(mut x: impl RwApi<Target=u64>) -> u64 {
if *x.read() == 1 {
*write_x(&mut x) = 2;
*x.read()
} else {
*x.read()
}
}
fn write_x<T: WriteApi>(x: &mut T) -> T::WriteGuard<'_> {
x.write()
}
assert_eq!(do_something(RwApiWrapperOwned(1)), 2);
assert_eq!(do_something(RwApiWrapperOwned(3)), 3);
assert_eq!(do_something(&mut RwApiWrapperOwned(1)), 2);
assert_eq!(do_something(&mut RwApiWrapperOwned(3)), 3);
assert_eq!(do_something(RwLock::new(1)), 2);
assert_eq!(do_something(RwLock::new(3)), 3);
assert_eq!(do_something(&RwLock::new(1)), 2);
assert_eq!(do_something(&RwLock::new(3)), 3);
assert_eq!(do_something(&mut RwLock::new(1)), 2);
assert_eq!(do_something(&mut RwLock::new(3)), 3);
fn do_something_ref<'a>(mut x: impl RwApi<Target=&'a mut u64>) -> u64 {
if **x.read() == 1 {
**write_x(&mut x) = 2;
**x.read()
} else {
**x.read()
}
}
assert_eq!(do_something_ref(RwApiWrapper(&mut 1)), 2);
assert_eq!(do_something_ref(RwApiWrapper(&mut 3)), 3);
assert_eq!(do_something_ref(&mut RwApiWrapper(&mut 1)), 2);
assert_eq!(do_something_ref(&mut RwApiWrapper(&mut 3)), 3);
assert_eq!(do_something_ref(RwLock::new(&mut 1)), 2);
assert_eq!(do_something_ref(RwLock::new(&mut 3)), 3);
assert_eq!(do_something_ref(&RwLock::new(&mut 1)), 2);
assert_eq!(do_something_ref(&RwLock::new(&mut 3)), 3);
assert_eq!(do_something_ref(&mut RwLock::new(&mut 1)), 2);
assert_eq!(do_something_ref(&mut RwLock::new(&mut 3)), 3);Required Associated Types§
Sourcetype WriteGuard<'a>: DerefMut<Target = Self::Target>
where
Self: 'a
type WriteGuard<'a>: DerefMut<Target = Self::Target> where Self: 'a
Self::write return type.
Required Methods§
Sourcefn write(&mut self) -> Self::WriteGuard<'_>
fn write(&mut self) -> Self::WriteGuard<'_>
Generalizes RwLock::write.
Dyn Compatibility§
This trait is not dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.