Expand documentation to explain facade type
This commit is contained in:
parent
82c8f570f2
commit
cb905d0a83
|
@ -29,6 +29,9 @@ mod utils;
|
||||||
///
|
///
|
||||||
/// While `T` does not have to implement `Composite` to be used with `Shared`,
|
/// While `T` does not have to implement `Composite` to be used with `Shared`,
|
||||||
/// the primary use of `Shared` is with types that implement `Composite`.
|
/// the primary use of `Shared` is with types that implement `Composite`.
|
||||||
|
///
|
||||||
|
/// When the `client` feature is disabled, this does nothing (same as just `T`),
|
||||||
|
/// since `Composite` structures are disabled.
|
||||||
#[cfg(feature = "client")]
|
#[cfg(feature = "client")]
|
||||||
pub type Shared<T> = Arc<RwLock<T>>;
|
pub type Shared<T> = Arc<RwLock<T>>;
|
||||||
#[cfg(not(feature = "client"))]
|
#[cfg(not(feature = "client"))]
|
||||||
|
|
Loading…
Reference in New Issue