added example back in, with a modified, (hopefully) improved description

This commit is contained in:
Junseok Lee 2015-02-05 23:46:30 -08:00
parent b6544fd352
commit 310ada06f2

View File

@ -308,6 +308,20 @@ fn clone(&self) -> ContravariantType<T> { *self }
///
/// For more information about variance, refer to this Wikipedia
/// article <http://en.wikipedia.org/wiki/Variance_%28computer_science%29>.
///
/// # Example
///
/// The Cell type is an example of an `InvariantType` which uses unsafe
/// code to achieve "interior" mutability:
///
/// ```
/// struct Cell<T> { value: T }
/// ```
///
/// The type system would infer that `value` is only read here
/// and never written, but in fact `Cell` uses unsafe code to achieve
/// interior mutability. In order to get correct behavior, the
/// `InvariantType` marker must be applied.
#[unstable(feature = "core",
reason = "likely to change with new variance strategy")]
#[lang="invariant_type"]