crossbeam_channel/select_macro.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
//! The `select!` macro.
/// A helper macro for `select!` to hide the long list of macro patterns from the documentation.
///
/// The macro consists of two stages:
/// 1. Parsing
/// 2. Code generation
///
/// The parsing stage consists of these subparts:
/// 1. `@list`: Turns a list of tokens into a list of cases.
/// 2. `@list_errorN`: Diagnoses the syntax error.
/// 3. `@case`: Parses a single case and verifies its argument list.
///
/// The codegen stage consists of these subparts:
/// 1. `@init`: Attempts to optimize `select!` away and initializes the list of handles.
/// 1. `@count`: Counts the listed cases.
/// 3. `@add`: Adds send/receive operations to the list of handles and starts selection.
/// 4. `@complete`: Completes the selected send/receive operation.
///
/// If the parsing stage encounters a syntax error or the codegen stage ends up with too many
/// cases to process, the macro fails with a compile-time error.
#[doc(hidden)]
#[macro_export]
macro_rules! crossbeam_channel_internal {
// The list is empty. Now check the arguments of each processed case.
(@list
()
($($head:tt)*)
) => {
$crate::crossbeam_channel_internal!(
@case
($($head)*)
()
()
)
};
// If necessary, insert an empty argument list after `default`.
(@list
(default => $($tail:tt)*)
($($head:tt)*)
) => {
$crate::crossbeam_channel_internal!(
@list
(default() => $($tail)*)
($($head)*)
)
};
// But print an error if `default` is followed by a `->`.
(@list
(default -> $($tail:tt)*)
($($head:tt)*)
) => {
compile_error!(
"expected `=>` after `default` case, found `->`"
)
};
// Print an error if there's an `->` after the argument list in the default case.
(@list
(default $args:tt -> $($tail:tt)*)
($($head:tt)*)
) => {
compile_error!(
"expected `=>` after `default` case, found `->`"
)
};
// Print an error if there is a missing result in a recv case.
(@list
(recv($($args:tt)*) => $($tail:tt)*)
($($head:tt)*)
) => {
compile_error!(
"expected `->` after `recv` case, found `=>`"
)
};
// Print an error if there is a missing result in a send case.
(@list
(send($($args:tt)*) => $($tail:tt)*)
($($head:tt)*)
) => {
compile_error!(
"expected `->` after `send` operation, found `=>`"
)
};
// Make sure the arrow and the result are not repeated.
(@list
($case:ident $args:tt -> $res:tt -> $($tail:tt)*)
($($head:tt)*)
) => {
compile_error!("expected `=>`, found `->`")
};
// Print an error if there is a semicolon after the block.
(@list
($case:ident $args:tt $(-> $res:pat)* => $body:block; $($tail:tt)*)
($($head:tt)*)
) => {
compile_error!(
"did you mean to put a comma instead of the semicolon after `}`?"
)
};
// The first case is separated by a comma.
(@list
($case:ident ($($args:tt)*) $(-> $res:pat)* => $body:expr, $($tail:tt)*)
($($head:tt)*)
) => {
$crate::crossbeam_channel_internal!(
@list
($($tail)*)
($($head)* $case ($($args)*) $(-> $res)* => { $body },)
)
};
// Don't require a comma after the case if it has a proper block.
(@list
($case:ident ($($args:tt)*) $(-> $res:pat)* => $body:block $($tail:tt)*)
($($head:tt)*)
) => {
$crate::crossbeam_channel_internal!(
@list
($($tail)*)
($($head)* $case ($($args)*) $(-> $res)* => { $body },)
)
};
// Only one case remains.
(@list
($case:ident ($($args:tt)*) $(-> $res:pat)* => $body:expr $(,)?)
($($head:tt)*)
) => {
$crate::crossbeam_channel_internal!(
@list
()
($($head)* $case ($($args)*) $(-> $res)* => { $body },)
)
};
// Diagnose and print an error.
(@list
($($tail:tt)*)
($($head:tt)*)
) => {
$crate::crossbeam_channel_internal!(@list_error1 $($tail)*)
};
// Stage 1: check the case type.
(@list_error1 recv $($tail:tt)*) => {
$crate::crossbeam_channel_internal!(@list_error2 recv $($tail)*)
};
(@list_error1 send $($tail:tt)*) => {
$crate::crossbeam_channel_internal!(@list_error2 send $($tail)*)
};
(@list_error1 default $($tail:tt)*) => {
$crate::crossbeam_channel_internal!(@list_error2 default $($tail)*)
};
(@list_error1 $t:tt $($tail:tt)*) => {
compile_error!(
concat!(
"expected one of `recv`, `send`, or `default`, found `",
stringify!($t),
"`",
)
)
};
(@list_error1 $($tail:tt)*) => {
$crate::crossbeam_channel_internal!(@list_error2 $($tail)*);
};
// Stage 2: check the argument list.
(@list_error2 $case:ident) => {
compile_error!(
concat!(
"missing argument list after `",
stringify!($case),
"`",
)
)
};
(@list_error2 $case:ident => $($tail:tt)*) => {
compile_error!(
concat!(
"missing argument list after `",
stringify!($case),
"`",
)
)
};
(@list_error2 $($tail:tt)*) => {
$crate::crossbeam_channel_internal!(@list_error3 $($tail)*)
};
// Stage 3: check the `=>` and what comes after it.
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)*) => {
compile_error!(
concat!(
"missing `=>` after `",
stringify!($case),
"` case",
)
)
};
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)* =>) => {
compile_error!(
"expected expression after `=>`"
)
};
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)* => $body:expr; $($tail:tt)*) => {
compile_error!(
concat!(
"did you mean to put a comma instead of the semicolon after `",
stringify!($body),
"`?",
)
)
};
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)* => recv($($a:tt)*) $($tail:tt)*) => {
compile_error!(
"expected an expression after `=>`"
)
};
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)* => send($($a:tt)*) $($tail:tt)*) => {
compile_error!(
"expected an expression after `=>`"
)
};
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)* => default($($a:tt)*) $($tail:tt)*) => {
compile_error!(
"expected an expression after `=>`"
)
};
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)* => $f:ident($($a:tt)*) $($tail:tt)*) => {
compile_error!(
concat!(
"did you mean to put a comma after `",
stringify!($f),
"(",
stringify!($($a)*),
")`?",
)
)
};
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)* => $f:ident!($($a:tt)*) $($tail:tt)*) => {
compile_error!(
concat!(
"did you mean to put a comma after `",
stringify!($f),
"!(",
stringify!($($a)*),
")`?",
)
)
};
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)* => $f:ident![$($a:tt)*] $($tail:tt)*) => {
compile_error!(
concat!(
"did you mean to put a comma after `",
stringify!($f),
"![",
stringify!($($a)*),
"]`?",
)
)
};
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)* => $f:ident!{$($a:tt)*} $($tail:tt)*) => {
compile_error!(
concat!(
"did you mean to put a comma after `",
stringify!($f),
"!{",
stringify!($($a)*),
"}`?",
)
)
};
(@list_error3 $case:ident($($args:tt)*) $(-> $r:pat)* => $body:tt $($tail:tt)*) => {
compile_error!(
concat!(
"did you mean to put a comma after `",
stringify!($body),
"`?",
)
)
};
(@list_error3 $case:ident($($args:tt)*) -> => $($tail:tt)*) => {
compile_error!("missing pattern after `->`")
};
(@list_error3 $case:ident($($args:tt)*) $t:tt $(-> $r:pat)* => $($tail:tt)*) => {
compile_error!(
concat!(
"expected `->`, found `",
stringify!($t),
"`",
)
)
};
(@list_error3 $case:ident($($args:tt)*) -> $t:tt $($tail:tt)*) => {
compile_error!(
concat!(
"expected a pattern, found `",
stringify!($t),
"`",
)
)
};
(@list_error3 recv($($args:tt)*) $t:tt $($tail:tt)*) => {
compile_error!(
concat!(
"expected `->`, found `",
stringify!($t),
"`",
)
)
};
(@list_error3 send($($args:tt)*) $t:tt $($tail:tt)*) => {
compile_error!(
concat!(
"expected `->`, found `",
stringify!($t),
"`",
)
)
};
(@list_error3 recv $args:tt $($tail:tt)*) => {
compile_error!(
concat!(
"expected an argument list after `recv`, found `",
stringify!($args),
"`",
)
)
};
(@list_error3 send $args:tt $($tail:tt)*) => {
compile_error!(
concat!(
"expected an argument list after `send`, found `",
stringify!($args),
"`",
)
)
};
(@list_error3 default $args:tt $($tail:tt)*) => {
compile_error!(
concat!(
"expected an argument list or `=>` after `default`, found `",
stringify!($args),
"`",
)
)
};
(@list_error3 $($tail:tt)*) => {
$crate::crossbeam_channel_internal!(@list_error4 $($tail)*)
};
// Stage 4: fail with a generic error message.
(@list_error4 $($tail:tt)*) => {
compile_error!("invalid syntax")
};
// Success! All cases were parsed.
(@case
()
$cases:tt
$default:tt
) => {
$crate::crossbeam_channel_internal!(
@init
$cases
$default
)
};
// Check the format of a recv case.
(@case
(recv($r:expr $(,)?) -> $res:pat => $body:tt, $($tail:tt)*)
($($cases:tt)*)
$default:tt
) => {
$crate::crossbeam_channel_internal!(
@case
($($tail)*)
($($cases)* recv($r) -> $res => $body,)
$default
)
};
// Print an error if the argument list is invalid.
(@case
(recv($($args:tt)*) -> $res:pat => $body:tt, $($tail:tt)*)
($($cases:tt)*)
$default:tt
) => {
compile_error!(
concat!(
"invalid argument list in `recv(",
stringify!($($args)*),
")`",
)
)
};
// Print an error if there is no argument list.
(@case
(recv $t:tt $($tail:tt)*)
($($cases:tt)*)
$default:tt
) => {
compile_error!(
concat!(
"expected an argument list after `recv`, found `",
stringify!($t),
"`",
)
)
};
// Check the format of a send case.
(@case
(send($s:expr, $m:expr $(,)?) -> $res:pat => $body:tt, $($tail:tt)*)
($($cases:tt)*)
$default:tt
) => {
$crate::crossbeam_channel_internal!(
@case
($($tail)*)
($($cases)* send($s, $m) -> $res => $body,)
$default
)
};
// Print an error if the argument list is invalid.
(@case
(send($($args:tt)*) -> $res:pat => $body:tt, $($tail:tt)*)
($($cases:tt)*)
$default:tt
) => {
compile_error!(
concat!(
"invalid argument list in `send(",
stringify!($($args)*),
")`",
)
)
};
// Print an error if there is no argument list.
(@case
(send $t:tt $($tail:tt)*)
($($cases:tt)*)
$default:tt
) => {
compile_error!(
concat!(
"expected an argument list after `send`, found `",
stringify!($t),
"`",
)
)
};
// Check the format of a default case.
(@case
(default() => $body:tt, $($tail:tt)*)
$cases:tt
()
) => {
$crate::crossbeam_channel_internal!(
@case
($($tail)*)
$cases
(default() => $body,)
)
};
// Check the format of a default case with timeout.
(@case
(default($timeout:expr $(,)?) => $body:tt, $($tail:tt)*)
$cases:tt
()
) => {
$crate::crossbeam_channel_internal!(
@case
($($tail)*)
$cases
(default($timeout) => $body,)
)
};
// Check for duplicate default cases...
(@case
(default $($tail:tt)*)
$cases:tt
($($def:tt)+)
) => {
compile_error!(
"there can be only one `default` case in a `select!` block"
)
};
// Print an error if the argument list is invalid.
(@case
(default($($args:tt)*) => $body:tt, $($tail:tt)*)
$cases:tt
$default:tt
) => {
compile_error!(
concat!(
"invalid argument list in `default(",
stringify!($($args)*),
")`",
)
)
};
// Print an error if there is an unexpected token after `default`.
(@case
(default $t:tt $($tail:tt)*)
$cases:tt
$default:tt
) => {
compile_error!(
concat!(
"expected an argument list or `=>` after `default`, found `",
stringify!($t),
"`",
)
)
};
// The case was not consumed, therefore it must be invalid.
(@case
($case:ident $($tail:tt)*)
$cases:tt
$default:tt
) => {
compile_error!(
concat!(
"expected one of `recv`, `send`, or `default`, found `",
stringify!($case),
"`",
)
)
};
// Optimize `select!` into `try_recv()`.
(@init
(recv($r:expr) -> $res:pat => $recv_body:tt,)
(default() => $default_body:tt,)
) => {{
match $r {
ref _r => {
let _r: &$crate::Receiver<_> = _r;
match _r.try_recv() {
::std::result::Result::Err($crate::TryRecvError::Empty) => {
$default_body
}
_res => {
let _res = _res.map_err(|_| $crate::RecvError);
let $res = _res;
$recv_body
}
}
}
}
}};
// Optimize `select!` into `recv()`.
(@init
(recv($r:expr) -> $res:pat => $body:tt,)
()
) => {{
match $r {
ref _r => {
let _r: &$crate::Receiver<_> = _r;
let _res = _r.recv();
let $res = _res;
$body
}
}
}};
// Optimize `select!` into `recv_timeout()`.
(@init
(recv($r:expr) -> $res:pat => $recv_body:tt,)
(default($timeout:expr) => $default_body:tt,)
) => {{
match $r {
ref _r => {
let _r: &$crate::Receiver<_> = _r;
match _r.recv_timeout($timeout) {
::std::result::Result::Err($crate::RecvTimeoutError::Timeout) => {
$default_body
}
_res => {
let _res = _res.map_err(|_| $crate::RecvError);
let $res = _res;
$recv_body
}
}
}
}
}};
// // Optimize the non-blocking case with two receive operations.
// (@init
// (recv($r1:expr) -> $res1:pat => $recv_body1:tt,)
// (recv($r2:expr) -> $res2:pat => $recv_body2:tt,)
// (default() => $default_body:tt,)
// ) => {{
// match $r1 {
// ref _r1 => {
// let _r1: &$crate::Receiver<_> = _r1;
//
// match $r2 {
// ref _r2 => {
// let _r2: &$crate::Receiver<_> = _r2;
//
// // TODO(stjepang): Implement this optimization.
// }
// }
// }
// }
// }};
// // Optimize the blocking case with two receive operations.
// (@init
// (recv($r1:expr) -> $res1:pat => $body1:tt,)
// (recv($r2:expr) -> $res2:pat => $body2:tt,)
// ()
// ) => {{
// match $r1 {
// ref _r1 => {
// let _r1: &$crate::Receiver<_> = _r1;
//
// match $r2 {
// ref _r2 => {
// let _r2: &$crate::Receiver<_> = _r2;
//
// // TODO(stjepang): Implement this optimization.
// }
// }
// }
// }
// }};
// // Optimize the case with two receive operations and a timeout.
// (@init
// (recv($r1:expr) -> $res1:pat => $recv_body1:tt,)
// (recv($r2:expr) -> $res2:pat => $recv_body2:tt,)
// (default($timeout:expr) => $default_body:tt,)
// ) => {{
// match $r1 {
// ref _r1 => {
// let _r1: &$crate::Receiver<_> = _r1;
//
// match $r2 {
// ref _r2 => {
// let _r2: &$crate::Receiver<_> = _r2;
//
// // TODO(stjepang): Implement this optimization.
// }
// }
// }
// }
// }};
// // Optimize `select!` into `try_send()`.
// (@init
// (send($s:expr, $m:expr) -> $res:pat => $send_body:tt,)
// (default() => $default_body:tt,)
// ) => {{
// match $s {
// ref _s => {
// let _s: &$crate::Sender<_> = _s;
// // TODO(stjepang): Implement this optimization.
// }
// }
// }};
// // Optimize `select!` into `send()`.
// (@init
// (send($s:expr, $m:expr) -> $res:pat => $body:tt,)
// ()
// ) => {{
// match $s {
// ref _s => {
// let _s: &$crate::Sender<_> = _s;
// // TODO(stjepang): Implement this optimization.
// }
// }
// }};
// // Optimize `select!` into `send_timeout()`.
// (@init
// (send($s:expr, $m:expr) -> $res:pat => $body:tt,)
// (default($timeout:expr) => $body:tt,)
// ) => {{
// match $s {
// ref _s => {
// let _s: &$crate::Sender<_> = _s;
// // TODO(stjepang): Implement this optimization.
// }
// }
// }};
// Create the list of handles and add operations to it.
(@init
($($cases:tt)*)
$default:tt
) => {{
const _LEN: usize = $crate::crossbeam_channel_internal!(@count ($($cases)*));
let _handle: &dyn $crate::internal::SelectHandle = &$crate::never::<()>();
#[allow(unused_mut)]
let mut _sel = [(_handle, 0, ::std::ptr::null()); _LEN];
$crate::crossbeam_channel_internal!(
@add
_sel
($($cases)*)
$default
(
(0usize _oper0)
(1usize _oper1)
(2usize _oper2)
(3usize _oper3)
(4usize _oper4)
(5usize _oper5)
(6usize _oper6)
(7usize _oper7)
(8usize _oper8)
(9usize _oper9)
(10usize _oper10)
(11usize _oper11)
(12usize _oper12)
(13usize _oper13)
(14usize _oper14)
(15usize _oper15)
(16usize _oper16)
(17usize _oper17)
(18usize _oper18)
(19usize _oper19)
(20usize _oper20)
(21usize _oper21)
(22usize _oper22)
(23usize _oper23)
(24usize _oper24)
(25usize _oper25)
(26usize _oper26)
(27usize _oper27)
(28usize _oper28)
(29usize _oper29)
(30usize _oper30)
(31usize _oper31)
)
()
)
}};
// Count the listed cases.
(@count ()) => {
0
};
(@count ($oper:ident $args:tt -> $res:pat => $body:tt, $($cases:tt)*)) => {
1 + $crate::crossbeam_channel_internal!(@count ($($cases)*))
};
// Run blocking selection.
(@add
$sel:ident
()
()
$labels:tt
$cases:tt
) => {{
let _oper: $crate::SelectedOperation<'_> = {
let _oper = $crate::internal::select(&mut $sel, _IS_BIASED);
// Erase the lifetime so that `sel` can be dropped early even without NLL.
unsafe { ::std::mem::transmute(_oper) }
};
$crate::crossbeam_channel_internal! {
@complete
$sel
_oper
$cases
}
}};
// Run non-blocking selection.
(@add
$sel:ident
()
(default() => $body:tt,)
$labels:tt
$cases:tt
) => {{
let _oper: ::std::option::Option<$crate::SelectedOperation<'_>> = {
let _oper = $crate::internal::try_select(&mut $sel, _IS_BIASED);
// Erase the lifetime so that `sel` can be dropped early even without NLL.
unsafe { ::std::mem::transmute(_oper) }
};
match _oper {
None => {
{ $sel };
$body
}
Some(_oper) => {
$crate::crossbeam_channel_internal! {
@complete
$sel
_oper
$cases
}
}
}
}};
// Run selection with a timeout.
(@add
$sel:ident
()
(default($timeout:expr) => $body:tt,)
$labels:tt
$cases:tt
) => {{
let _oper: ::std::option::Option<$crate::SelectedOperation<'_>> = {
let _oper = $crate::internal::select_timeout(&mut $sel, $timeout, _IS_BIASED);
// Erase the lifetime so that `sel` can be dropped early even without NLL.
unsafe { ::std::mem::transmute(_oper) }
};
match _oper {
::std::option::Option::None => {
{ $sel };
$body
}
::std::option::Option::Some(_oper) => {
$crate::crossbeam_channel_internal! {
@complete
$sel
_oper
$cases
}
}
}
}};
// Have we used up all labels?
(@add
$sel:ident
$input:tt
$default:tt
()
$cases:tt
) => {
compile_error!("too many operations in a `select!` block")
};
// Add a receive operation to `sel`.
(@add
$sel:ident
(recv($r:expr) -> $res:pat => $body:tt, $($tail:tt)*)
$default:tt
(($i:tt $var:ident) $($labels:tt)*)
($($cases:tt)*)
) => {{
match $r {
ref _r => {
let $var: &$crate::Receiver<_> = unsafe {
let _r: &$crate::Receiver<_> = _r;
// Erase the lifetime so that `sel` can be dropped early even without NLL.
unsafe fn unbind<'a, T>(x: &T) -> &'a T {
::std::mem::transmute(x)
}
unbind(_r)
};
$sel[$i] = ($var, $i, $var as *const $crate::Receiver<_> as *const u8);
$crate::crossbeam_channel_internal!(
@add
$sel
($($tail)*)
$default
($($labels)*)
($($cases)* [$i] recv($var) -> $res => $body,)
)
}
}
}};
// Add a send operation to `sel`.
(@add
$sel:ident
(send($s:expr, $m:expr) -> $res:pat => $body:tt, $($tail:tt)*)
$default:tt
(($i:tt $var:ident) $($labels:tt)*)
($($cases:tt)*)
) => {{
match $s {
ref _s => {
let $var: &$crate::Sender<_> = unsafe {
let _s: &$crate::Sender<_> = _s;
// Erase the lifetime so that `sel` can be dropped early even without NLL.
unsafe fn unbind<'a, T>(x: &T) -> &'a T {
::std::mem::transmute(x)
}
unbind(_s)
};
$sel[$i] = ($var, $i, $var as *const $crate::Sender<_> as *const u8);
$crate::crossbeam_channel_internal!(
@add
$sel
($($tail)*)
$default
($($labels)*)
($($cases)* [$i] send($var, $m) -> $res => $body,)
)
}
}
}};
// Complete a receive operation.
(@complete
$sel:ident
$oper:ident
([$i:tt] recv($r:ident) -> $res:pat => $body:tt, $($tail:tt)*)
) => {{
if $oper.index() == $i {
let _res = $oper.recv($r);
{ $sel };
let $res = _res;
$body
} else {
$crate::crossbeam_channel_internal! {
@complete
$sel
$oper
($($tail)*)
}
}
}};
// Complete a send operation.
(@complete
$sel:ident
$oper:ident
([$i:tt] send($s:ident, $m:expr) -> $res:pat => $body:tt, $($tail:tt)*)
) => {{
if $oper.index() == $i {
let _res = $oper.send($s, $m);
{ $sel };
let $res = _res;
$body
} else {
$crate::crossbeam_channel_internal! {
@complete
$sel
$oper
($($tail)*)
}
}
}};
// Panic if we don't identify the selected case, but this should never happen.
(@complete
$sel:ident
$oper:ident
()
) => {{
unreachable!(
"internal error in crossbeam-channel: invalid case"
)
}};
// Catches a bug within this macro (should not happen).
(@$($tokens:tt)*) => {
compile_error!(
concat!(
"internal error in crossbeam-channel: ",
stringify!(@$($tokens)*),
)
)
};
// The entry points.
() => {
compile_error!("empty `select!` block")
};
($($case:ident $(($($args:tt)*))* => $body:expr $(,)*)*) => {
$crate::crossbeam_channel_internal!(
@list
($($case $(($($args)*))* => { $body },)*)
()
)
};
($($tokens:tt)*) => {
$crate::crossbeam_channel_internal!(
@list
($($tokens)*)
()
)
};
}
/// Selects from a set of channel operations.
///
/// This macro allows you to define a set of channel operations, wait until any one of them becomes
/// ready, and finally execute it. If multiple operations are ready at the same time, a random one
/// among them is selected (i.e. the unbiased selection). Use `select_biased!` for the biased
/// selection.
///
/// It is also possible to define a `default` case that gets executed if none of the operations are
/// ready, either right away or for a certain duration of time.
///
/// An operation is considered to be ready if it doesn't have to block. Note that it is ready even
/// when it will simply return an error because the channel is disconnected.
///
/// The `select!` macro is a convenience wrapper around [`Select`]. However, it cannot select over a
/// dynamically created list of channel operations.
///
/// [`Select`]: super::Select
///
/// # Examples
///
/// Block until a send or a receive operation is selected:
///
/// ```
/// use crossbeam_channel::{select, unbounded};
///
/// let (s1, r1) = unbounded();
/// let (s2, r2) = unbounded();
/// s1.send(10).unwrap();
///
/// // Since both operations are initially ready, a random one will be executed.
/// select! {
/// recv(r1) -> msg => assert_eq!(msg, Ok(10)),
/// send(s2, 20) -> res => {
/// assert_eq!(res, Ok(()));
/// assert_eq!(r2.recv(), Ok(20));
/// }
/// }
/// ```
///
/// Select from a set of operations without blocking:
///
/// ```
/// use std::thread;
/// use std::time::Duration;
/// use crossbeam_channel::{select, unbounded};
///
/// let (s1, r1) = unbounded();
/// let (s2, r2) = unbounded();
///
/// thread::spawn(move || {
/// thread::sleep(Duration::from_secs(1));
/// s1.send(10).unwrap();
/// });
/// thread::spawn(move || {
/// thread::sleep(Duration::from_millis(500));
/// s2.send(20).unwrap();
/// });
///
/// // None of the operations are initially ready.
/// select! {
/// recv(r1) -> msg => panic!(),
/// recv(r2) -> msg => panic!(),
/// default => println!("not ready"),
/// }
/// ```
///
/// Select over a set of operations with a timeout:
///
/// ```
/// use std::thread;
/// use std::time::Duration;
/// use crossbeam_channel::{select, unbounded};
///
/// let (s1, r1) = unbounded();
/// let (s2, r2) = unbounded();
///
/// thread::spawn(move || {
/// thread::sleep(Duration::from_secs(1));
/// s1.send(10).unwrap();
/// });
/// thread::spawn(move || {
/// thread::sleep(Duration::from_millis(500));
/// s2.send(20).unwrap();
/// });
///
/// // None of the two operations will become ready within 100 milliseconds.
/// select! {
/// recv(r1) -> msg => panic!(),
/// recv(r2) -> msg => panic!(),
/// default(Duration::from_millis(100)) => println!("timed out"),
/// }
/// ```
///
/// Optionally add a receive operation to `select!` using [`never`]:
///
/// ```
/// use std::thread;
/// use std::time::Duration;
/// use crossbeam_channel::{select, never, unbounded};
///
/// let (s1, r1) = unbounded();
/// let (s2, r2) = unbounded();
///
/// thread::spawn(move || {
/// thread::sleep(Duration::from_secs(1));
/// s1.send(10).unwrap();
/// });
/// thread::spawn(move || {
/// thread::sleep(Duration::from_millis(500));
/// s2.send(20).unwrap();
/// });
///
/// // This receiver can be a `Some` or a `None`.
/// let r2 = Some(&r2);
///
/// // None of the two operations will become ready within 100 milliseconds.
/// select! {
/// recv(r1) -> msg => panic!(),
/// recv(r2.unwrap_or(&never())) -> msg => assert_eq!(msg, Ok(20)),
/// }
/// ```
///
/// To optionally add a timeout to `select!`, see the [example] for [`never`].
///
/// [`never`]: super::never
/// [example]: super::never#examples
#[macro_export]
macro_rules! select {
($($tokens:tt)*) => {
{
const _IS_BIASED: bool = false;
$crate::crossbeam_channel_internal!(
$($tokens)*
)
}
};
}
/// Selects from a set of channel operations.
///
/// This macro allows you to define a list of channel operations, wait until any one of them
/// becomes ready, and finally execute it. If multiple operations are ready at the same time, the
/// operation nearest to the front of the list is always selected (i.e. the biased selection). Use
/// [`select!`] for the unbiased selection.
///
/// Otherwise, this macro's functionality is identical to [`select!`]. Refer to it for the syntax.
#[macro_export]
macro_rules! select_biased {
($($tokens:tt)*) => {
{
const _IS_BIASED: bool = true;
$crate::crossbeam_channel_internal!(
$($tokens)*
)
}
};
}