kozabrada123/chorus
kozabrada123
/
chorus
mirror of https://github.com/polyphony-chat/chorus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Expand documentation to explain facade type

This commit is contained in:
Quat3rnion 2024-06-04 13:34:58 -04:00
parent 82c8f570f2
commit cb905d0a83
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/types/mod.rs
View File

@ -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"))]