squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Document that Result.unwrap prints the Err's value

Browse source 
It is implied by the Show bound, but that implication can be missed.
This commit is contained in:
masklinn 2014-07-12 17:02:15 +02:00 committed by masklinn
parent da4e4e4e0a
commit ded48c5847
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/libcore/result.rs
View file

@ -536,7 +536,10 @@ impl<T, E> Result<T, E> {
impl<T, E: Show> Result<T, E> {
/// Unwraps a result, yielding the content of an `Ok`.
///
/// Fails if the value is an `Err`.
/// # Failure
///
/// Fails if the value is an `Err`, with a custom failure message provided
/// by the `Err`'s value.
#[inline]
pub fn unwrap(self) -> T {
match self {
@ -550,7 +553,10 @@ impl<T, E: Show> Result<T, E> {
impl<T: Show, E> Result<T, E> {
/// Unwraps a result, yielding the content of an `Err`.
///
/// Fails if the value is an `Ok`.
/// # Failure
///
/// Fails if the value is an `Ok`, with a custom failure message provided
/// by the `Ok`'s value.
#[inline]
pub fn unwrap_err(self) -> E {
match self {