library/core/tests/result.rs

   1 use core::ops::DerefMut;
   2 use core::option::*;
   3
   4 fn op1() -> Result<isize, &'static str> {
   5     Ok(666)
   6 }
   7 fn op2() -> Result<isize, &'static str> {
   8     Err("sadface")
   9 }
  10
  11 #[test]
  12 fn test_and() {
  13     assert_eq!(op1().and(Ok(667)).unwrap(), 667);
  14     assert_eq!(op1().and(Err::<i32, &'static str>("bad")).unwrap_err(), "bad");
  15
  16     assert_eq!(op2().and(Ok(667)).unwrap_err(), "sadface");
  17     assert_eq!(op2().and(Err::<i32, &'static str>("bad")).unwrap_err(), "sadface");
  18 }
  19
  20 #[test]
  21 fn test_and_then() {
  22     assert_eq!(op1().and_then(|i| Ok::<isize, &'static str>(i + 1)).unwrap(), 667);
  23     assert_eq!(op1().and_then(|_| Err::<isize, &'static str>("bad")).unwrap_err(), "bad");
  24
  25     assert_eq!(op2().and_then(|i| Ok::<isize, &'static str>(i + 1)).unwrap_err(), "sadface");
  26     assert_eq!(op2().and_then(|_| Err::<isize, &'static str>("bad")).unwrap_err(), "sadface");
  27 }
  28
  29 #[test]
  30 fn test_or() {
  31     assert_eq!(op1().or(Ok::<_, &'static str>(667)).unwrap(), 666);
  32     assert_eq!(op1().or(Err("bad")).unwrap(), 666);
  33
  34     assert_eq!(op2().or(Ok::<_, &'static str>(667)).unwrap(), 667);
  35     assert_eq!(op2().or(Err("bad")).unwrap_err(), "bad");
  36 }
  37
  38 #[test]
  39 fn test_or_else() {
  40     assert_eq!(op1().or_else(|_| Ok::<isize, &'static str>(667)).unwrap(), 666);
  41     assert_eq!(op1().or_else(|e| Err::<isize, &'static str>(e)).unwrap(), 666);
  42
  43     assert_eq!(op2().or_else(|_| Ok::<isize, &'static str>(667)).unwrap(), 667);
  44     assert_eq!(op2().or_else(|e| Err::<isize, &'static str>(e)).unwrap_err(), "sadface");
  45 }
  46
  47 #[test]
  48 fn test_impl_map() {
  49     assert!(Ok::<isize, isize>(1).map(|x| x + 1) == Ok(2));
  50     assert!(Err::<isize, isize>(1).map(|x| x + 1) == Err(1));
  51 }
  52
  53 #[test]
  54 fn test_impl_map_err() {
  55     assert!(Ok::<isize, isize>(1).map_err(|x| x + 1) == Ok(1));
  56     assert!(Err::<isize, isize>(1).map_err(|x| x + 1) == Err(2));
  57 }
  58
  59 #[test]
  60 fn test_collect() {
  61     let v: Result<Vec<isize>, ()> = (0..0).map(|_| Ok::<isize, ()>(0)).collect();
  62     assert!(v == Ok(vec![]));
  63
  64     let v: Result<Vec<isize>, ()> = (0..3).map(|x| Ok::<isize, ()>(x)).collect();
  65     assert!(v == Ok(vec![0, 1, 2]));
  66
  67     let v: Result<Vec<isize>, isize> = (0..3).map(|x| if x > 1 { Err(x) } else { Ok(x) }).collect();
  68     assert!(v == Err(2));
  69
  70     // test that it does not take more elements than it needs
  71     let mut functions: [Box<dyn Fn() -> Result<(), isize>>; 3] =
  72         [Box::new(|| Ok(())), Box::new(|| Err(1)), Box::new(|| panic!())];
  73
  74     let v: Result<Vec<()>, isize> = functions.iter_mut().map(|f| (*f)()).collect();
  75     assert!(v == Err(1));
  76 }
  77
  78 #[test]
  79 fn test_fmt_default() {
  80     let ok: Result<isize, &'static str> = Ok(100);
  81     let err: Result<isize, &'static str> = Err("Err");
  82
  83     let s = format!("{ok:?}");
  84     assert_eq!(s, "Ok(100)");
  85     let s = format!("{err:?}");
  86     assert_eq!(s, "Err(\"Err\")");
  87 }
  88
  89 #[test]
  90 fn test_unwrap_or() {
  91     let ok: Result<isize, &'static str> = Ok(100);
  92     let ok_err: Result<isize, &'static str> = Err("Err");
  93
  94     assert_eq!(ok.unwrap_or(50), 100);
  95     assert_eq!(ok_err.unwrap_or(50), 50);
  96 }
  97
  98 #[test]
  99 fn test_unwrap_or_else() {
 100     fn handler(msg: &'static str) -> isize {
 101         if msg == "I got this." { 50 } else { panic!("BadBad") }
 102     }
 103
 104     let ok: Result<isize, &'static str> = Ok(100);
 105     let ok_err: Result<isize, &'static str> = Err("I got this.");
 106
 107     assert_eq!(ok.unwrap_or_else(handler), 100);
 108     assert_eq!(ok_err.unwrap_or_else(handler), 50);
 109 }
 110
 111 #[test]
 112 #[should_panic]
 113 pub fn test_unwrap_or_else_panic() {
 114     fn handler(msg: &'static str) -> isize {
 115         if msg == "I got this." { 50 } else { panic!("BadBad") }
 116     }
 117
 118     let bad_err: Result<isize, &'static str> = Err("Unrecoverable mess.");
 119     let _: isize = bad_err.unwrap_or_else(handler);
 120 }
 121
 122 #[test]
 123 fn test_unwrap_unchecked() {
 124     let ok: Result<isize, &'static str> = Ok(100);
 125     assert_eq!(unsafe { ok.unwrap_unchecked() }, 100);
 126 }
 127
 128 #[test]
 129 fn test_unwrap_err_unchecked() {
 130     let ok_err: Result<isize, &'static str> = Err("Err");
 131     assert_eq!(unsafe { ok_err.unwrap_err_unchecked() }, "Err");
 132 }
 133
 134 #[test]
 135 pub fn test_expect_ok() {
 136     let ok: Result<isize, &'static str> = Ok(100);
 137     assert_eq!(ok.expect("Unexpected error"), 100);
 138 }
 139 #[test]
 140 #[should_panic(expected = "Got expected error: \"All good\"")]
 141 pub fn test_expect_err() {
 142     let err: Result<isize, &'static str> = Err("All good");
 143     err.expect("Got expected error");
 144 }
 145
 146 #[test]
 147 pub fn test_expect_err_err() {
 148     let ok: Result<&'static str, isize> = Err(100);
 149     assert_eq!(ok.expect_err("Unexpected ok"), 100);
 150 }
 151 #[test]
 152 #[should_panic(expected = "Got expected ok: \"All good\"")]
 153 pub fn test_expect_err_ok() {
 154     let err: Result<&'static str, isize> = Ok("All good");
 155     err.expect_err("Got expected ok");
 156 }
 157
 158 #[test]
 159 pub fn test_iter() {
 160     let ok: Result<isize, &'static str> = Ok(100);
 161     let mut it = ok.iter();
 162     assert_eq!(it.size_hint(), (1, Some(1)));
 163     assert_eq!(it.next(), Some(&100));
 164     assert_eq!(it.size_hint(), (0, Some(0)));
 165     assert!(it.next().is_none());
 166     assert_eq!((&ok).into_iter().next(), Some(&100));
 167
 168     let err: Result<isize, &'static str> = Err("error");
 169     assert_eq!(err.iter().next(), None);
 170 }
 171
 172 #[test]
 173 pub fn test_iter_mut() {
 174     let mut ok: Result<isize, &'static str> = Ok(100);
 175     for loc in ok.iter_mut() {
 176         *loc = 200;
 177     }
 178     assert_eq!(ok, Ok(200));
 179     for loc in &mut ok {
 180         *loc = 300;
 181     }
 182     assert_eq!(ok, Ok(300));
 183
 184     let mut err: Result<isize, &'static str> = Err("error");
 185     for loc in err.iter_mut() {
 186         *loc = 200;
 187     }
 188     assert_eq!(err, Err("error"));
 189 }
 190
 191 #[test]
 192 pub fn test_unwrap_or_default() {
 193     assert_eq!(op1().unwrap_or_default(), 666);
 194     assert_eq!(op2().unwrap_or_default(), 0);
 195 }
 196
 197 #[test]
 198 pub fn test_into_ok() {
 199     fn infallible_op() -> Result<isize, !> {
 200         Ok(666)
 201     }
 202
 203     assert_eq!(infallible_op().into_ok(), 666);
 204
 205     enum MyNeverToken {}
 206     impl From<MyNeverToken> for ! {
 207         fn from(never: MyNeverToken) -> ! {
 208             match never {}
 209         }
 210     }
 211
 212     fn infallible_op2() -> Result<isize, MyNeverToken> {
 213         Ok(667)
 214     }
 215
 216     assert_eq!(infallible_op2().into_ok(), 667);
 217 }
 218
 219 #[test]
 220 pub fn test_into_err() {
 221     fn until_error_op() -> Result<!, isize> {
 222         Err(666)
 223     }
 224
 225     assert_eq!(until_error_op().into_err(), 666);
 226
 227     enum MyNeverToken {}
 228     impl From<MyNeverToken> for ! {
 229         fn from(never: MyNeverToken) -> ! {
 230             match never {}
 231         }
 232     }
 233
 234     fn until_error_op2() -> Result<MyNeverToken, isize> {
 235         Err(667)
 236     }
 237
 238     assert_eq!(until_error_op2().into_err(), 667);
 239 }
 240
 241 #[test]
 242 fn test_try() {
 243     fn try_result_ok() -> Result<u8, u32> {
 244         let result: Result<u8, u8> = Ok(1);
 245         let val = result?;
 246         Ok(val)
 247     }
 248     assert_eq!(try_result_ok(), Ok(1));
 249
 250     fn try_result_err() -> Result<u8, u32> {
 251         let result: Result<u8, u8> = Err(1);
 252         let val = result?;
 253         Ok(val)
 254     }
 255     assert_eq!(try_result_err(), Err(1));
 256 }
 257
 258 #[test]
 259 fn test_result_as_deref() {
 260     // &Result<T: Deref, E>::Ok(T).as_deref() ->
 261     //      Result<&T::Deref::Target, &E>::Ok(&*T)
 262     let ref_ok = &Result::Ok::<&i32, u8>(&42);
 263     let expected_result = Result::Ok::<&i32, &u8>(&42);
 264     assert_eq!(ref_ok.as_deref(), expected_result);
 265
 266     let ref_ok = &Result::Ok::<String, u32>(String::from("a result"));
 267     let expected_result = Result::Ok::<&str, &u32>("a result");
 268     assert_eq!(ref_ok.as_deref(), expected_result);
 269
 270     let ref_ok = &Result::Ok::<Vec<i32>, u32>(vec![1, 2, 3, 4, 5]);
 271     let expected_result = Result::Ok::<&[i32], &u32>([1, 2, 3, 4, 5].as_slice());
 272     assert_eq!(ref_ok.as_deref(), expected_result);
 273
 274     // &Result<T: Deref, E>::Err(T).as_deref() ->
 275     //      Result<&T::Deref::Target, &E>::Err(&*E)
 276     let val = 41;
 277     let ref_err = &Result::Err::<&u8, i32>(val);
 278     let expected_result = Result::Err::<&u8, &i32>(&val);
 279     assert_eq!(ref_err.as_deref(), expected_result);
 280
 281     let s = String::from("an error");
 282     let ref_err = &Result::Err::<&u32, String>(s.clone());
 283     let expected_result = Result::Err::<&u32, &String>(&s);
 284     assert_eq!(ref_err.as_deref(), expected_result);
 285
 286     let v = vec![5, 4, 3, 2, 1];
 287     let ref_err = &Result::Err::<&u32, Vec<i32>>(v.clone());
 288     let expected_result = Result::Err::<&u32, &Vec<i32>>(&v);
 289     assert_eq!(ref_err.as_deref(), expected_result);
 290 }
 291
 292 #[test]
 293 fn test_result_as_deref_mut() {
 294     // &mut Result<T: DerefMut, E>::Ok(T).as_deref_mut() ->
 295     //      Result<&mut T::DerefMut::Target, &mut E>::Ok(&mut *T)
 296     let mut val = 42;
 297     let mut expected_val = 42;
 298     let mut_ok = &mut Result::Ok::<&mut i32, u8>(&mut val);
 299     let expected_result = Result::Ok::<&mut i32, &mut u8>(&mut expected_val);
 300     assert_eq!(mut_ok.as_deref_mut(), expected_result);
 301
 302     let mut expected_string = String::from("a result");
 303     let mut_ok = &mut Result::Ok::<String, u32>(expected_string.clone());
 304     let expected_result = Result::Ok::<&mut str, &mut u32>(expected_string.deref_mut());
 305     assert_eq!(mut_ok.as_deref_mut(), expected_result);
 306
 307     let mut expected_vec = vec![1, 2, 3, 4, 5];
 308     let mut_ok = &mut Result::Ok::<Vec<i32>, u32>(expected_vec.clone());
 309     let expected_result = Result::Ok::<&mut [i32], &mut u32>(expected_vec.as_mut_slice());
 310     assert_eq!(mut_ok.as_deref_mut(), expected_result);
 311
 312     // &mut Result<T: DerefMut, E>::Err(T).as_deref_mut() ->
 313     //      Result<&mut T, &mut E>::Err(&mut *E)
 314     let mut val = 41;
 315     let mut_err = &mut Result::Err::<&mut u8, i32>(val);
 316     let expected_result = Result::Err::<&mut u8, &mut i32>(&mut val);
 317     assert_eq!(mut_err.as_deref_mut(), expected_result);
 318
 319     let mut expected_string = String::from("an error");
 320     let mut_err = &mut Result::Err::<&mut u32, String>(expected_string.clone());
 321     let expected_result = Result::Err::<&mut u32, &mut String>(&mut expected_string);
 322     assert_eq!(mut_err.as_deref_mut(), expected_result);
 323
 324     let mut expected_vec = vec![5, 4, 3, 2, 1];
 325     let mut_err = &mut Result::Err::<&mut u32, Vec<i32>>(expected_vec.clone());
 326     let expected_result = Result::Err::<&mut u32, &mut Vec<i32>>(&mut expected_vec);
 327     assert_eq!(mut_err.as_deref_mut(), expected_result);
 328 }
 329
 330 #[test]
 331 fn result_const() {
 332     // test that the methods of `Result` are usable in a const context
 333
 334     const RESULT: Result<usize, bool> = Ok(32);
 335
 336     const REF: Result<&usize, &bool> = RESULT.as_ref();
 337     assert_eq!(REF, Ok(&32));
 338
 339     const IS_OK: bool = RESULT.is_ok();
 340     assert!(IS_OK);
 341
 342     const IS_ERR: bool = RESULT.is_err();
 343     assert!(!IS_ERR)
 344 }
 345
 346 #[test]
 347 const fn result_const_mut() {
 348     let mut result: Result<usize, bool> = Ok(32);
 349
 350     {
 351         let as_mut = result.as_mut();
 352         match as_mut {
 353             Ok(v) => *v = 42,
 354             Err(_) => unreachable!(),
 355         }
 356     }
 357
 358     let mut result_err: Result<usize, bool> = Err(false);
 359
 360     {
 361         let as_mut = result_err.as_mut();
 362         match as_mut {
 363             Ok(_) => unreachable!(),
 364             Err(v) => *v = true,
 365         }
 366     }
 367 }
 368
 369 #[test]
 370 fn result_opt_conversions() {
 371     #[derive(Copy, Clone, Debug, PartialEq)]
 372     struct BadNumErr;
 373
 374     fn try_num(x: i32) -> Result<i32, BadNumErr> {
 375         if x <= 5 { Ok(x + 1) } else { Err(BadNumErr) }
 376     }
 377
 378     type ResOpt = Result<Option<i32>, BadNumErr>;
 379     type OptRes = Option<Result<i32, BadNumErr>>;
 380
 381     let mut x: ResOpt = Ok(Some(5));
 382     let mut y: OptRes = Some(Ok(5));
 383     assert_eq!(x, y.transpose());
 384     assert_eq!(x.transpose(), y);
 385
 386     x = Ok(None);
 387     y = None;
 388     assert_eq!(x, y.transpose());
 389     assert_eq!(x.transpose(), y);
 390
 391     x = Err(BadNumErr);
 392     y = Some(Err(BadNumErr));
 393     assert_eq!(x, y.transpose());
 394     assert_eq!(x.transpose(), y);
 395
 396     let res: Result<Vec<i32>, BadNumErr> = (0..10)
 397         .map(|x| {
 398             let y = try_num(x)?;
 399             Ok(if y % 2 == 0 { Some(y - 1) } else { None })
 400         })
 401         .filter_map(Result::transpose)
 402         .collect();
 403
 404     assert_eq!(res, Err(BadNumErr))
 405 }
 406
 407 #[test]
 408 fn result_try_trait_v2_branch() {
 409     use core::num::NonZeroU32;
 410     use core::ops::{ControlFlow::*, Try};
 411     assert_eq!(Ok::<i32, i32>(4).branch(), Continue(4));
 412     assert_eq!(Err::<i32, i32>(4).branch(), Break(Err(4)));
 413     let one = NonZeroU32::new(1).unwrap();
 414     assert_eq!(Ok::<(), NonZeroU32>(()).branch(), Continue(()));
 415     assert_eq!(Err::<(), NonZeroU32>(one).branch(), Break(Err(one)));
 416     assert_eq!(Ok::<NonZeroU32, ()>(one).branch(), Continue(one));
 417     assert_eq!(Err::<NonZeroU32, ()>(()).branch(), Break(Err(())));
 418 }