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
//! A library for to allow multiple return types by automatically generated enum.
//!
//! This crate is a procedural macro implementation of the features discussions
//! in [rust-lang/rfcs#2414]. This idea is also known as
//! ["Anonymous sum types"][rust-lang/rfcs#294].
//!
//! This library provides the following attribute macros:
//!
//! * `#[auto_enum]`
//!
//! Parses syntax, creates the enum, inserts variants, and passes specified
//! traits to `#[enum_derive]`.
//!
//! * `#[enum_derive]`
//!
//! Implements specified traits to the enum.
//!
//! # `#[auto_enum]`
//!
//! `#[auto_enum]`'s basic feature is to wrap the value returned by the obvious
//! branches (`match`, `if`, `return`, etc..) by an enum that implemented the
//! specified traits.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum(Iterator)]
//! fn foo(x: i32) -> impl Iterator<Item = i32> {
//! match x {
//! 0 => 1..10,
//! _ => vec![5, 10].into_iter(),
//! }
//! }
//! ```
//!
//! `#[auto_enum]` generates code in two stages.
//!
//! First, `#[auto_enum]` will do the following.
//!
//! * parses syntax
//! * creates the enum
//! * inserts variants
//!
//! Code like this will be generated:
//!
//! ```rust
//! fn foo(x: i32) -> impl Iterator<Item = i32> {
//! #[::auto_enums::enum_derive(Iterator)]
//! enum __Enum1<__T1, __T2> {
//! __T1(__T1),
//! __T2(__T2),
//! }
//!
//! match x {
//! 0 => __Enum1::__T1(1..10),
//! _ => __Enum1::__T2(vec![5, 10].into_iter()),
//! }
//! }
//! ```
//!
//! Next, `#[enum_derive]` implements the specified traits.
//!
//! <details>
//! <summary>Code like this will be generated:</summary>
//!
//! ```rust
//! fn foo(x: i32) -> impl Iterator<Item = i32> {
//! enum __Enum1<__T1, __T2> {
//! __T1(__T1),
//! __T2(__T2),
//! }
//!
//! impl<__T1, __T2> ::core::iter::Iterator for __Enum1<__T1, __T2>
//! where
//! __T1: ::core::iter::Iterator,
//! __T2: ::core::iter::Iterator<Item = <__T1 as ::core::iter::Iterator>::Item>,
//! {
//! type Item = <__T1 as ::core::iter::Iterator>::Item;
//! #[inline]
//! fn next(&mut self) -> ::core::option::Option<Self::Item> {
//! match self {
//! __Enum1::__T1(x) => x.next(),
//! __Enum1::__T2(x) => x.next(),
//! }
//! }
//! #[inline]
//! fn size_hint(&self) -> (usize, ::core::option::Option<usize>) {
//! match self {
//! __Enum1::__T1(x) => x.size_hint(),
//! __Enum1::__T2(x) => x.size_hint(),
//! }
//! }
//! }
//!
//! match x {
//! 0 => __Enum1::__T1(1..10),
//! _ => __Enum1::__T2(vec![5, 10].into_iter()),
//! }
//! }
//! ```
//!
//! </details>
//! <br>
//!
//! ## Nested arms/branches
//!
//! `#[auto_enum]` can also parse nested arms/branches by using the `#[nested]`
//! attribute.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum(Iterator)]
//! fn foo(x: i32) -> impl Iterator<Item = i32> {
//! match x {
//! 0 => 1..10,
//! #[nested]
//! _ => match x {
//! 1 => vec![5, 10].into_iter(),
//! _ => 0..=x,
//! },
//! }
//! }
//! ```
//!
//! `#[nested]` can be used basically in the same place as `#[auto_enum]`,
//! except that `#[nested]` cannot be used in functions.
//!
//! ## Recursion
//!
//! If an error due to recursion occurs, you need to box branches where recursion occurs.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! struct Type {
//! child: Vec<Type>,
//! }
//!
//! impl Type {
//! #[auto_enum(Iterator)]
//! fn method(&self) -> impl Iterator<Item = ()> + '_ {
//! if self.child.is_empty() {
//! Some(()).into_iter()
//! } else {
//! // Boxing is only needed on branches where recursion occurs.
//! Box::new(self.child.iter().flat_map(|c| c.method())) as Box<dyn Iterator<Item = _>>
//! }
//! }
//! }
//! ```
//!
//! ## Positions where `#[auto_enum]` can be used.
//!
//! `#[auto_enum]` can be used in the following three places. However, since
//! [stmt_expr_attributes] and [proc_macro_hygiene] are not stabilized, you need
//! to use empty `#[auto_enum]` for functions except nightly.
//!
//! [stmt_expr_attributes]: https://github.com/rust-lang/rust/issues/15701
//! [proc_macro_hygiene]: https://github.com/rust-lang/rust/issues/54727
//!
//! * functions
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum(Iterator)]
//! fn func(x: i32) -> impl Iterator<Item=i32> {
//! if x == 0 {
//! Some(0).into_iter()
//! } else {
//! 0..x
//! }
//! }
//! ```
//!
//! * expressions
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum] // Nightly does not need an empty attribute to the function.
//! fn expr(x: i32) -> impl Iterator<Item=i32> {
//! #[auto_enum(Iterator)]
//! match x {
//! 0 => Some(0).into_iter(),
//! _ => 0..x,
//! }
//! }
//! ```
//!
//! * let binding
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum] // Nightly does not need an empty attribute to the function.
//! fn let_binding(x: i32) -> impl Iterator<Item=i32> {
//! #[auto_enum(Iterator)]
//! let iter = match x {
//! 0 => Some(0).into_iter(),
//! _ => 0..x,
//! };
//! iter
//! }
//! ```
//!
//! ## Supported syntax
//!
//! * `if` and `match`
//!
//! Wrap each branch with a variant.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! // if
//! #[auto_enum(Iterator)]
//! fn expr_if(x: i32) -> impl Iterator<Item=i32> {
//! if x == 0 {
//! Some(0).into_iter()
//! } else {
//! 0..x
//! }
//! }
//!
//! // match
//! #[auto_enum] // Nightly does not need an empty attribute to the function.
//! fn expr_match(x: i32) -> impl Iterator<Item=i32> {
//! #[auto_enum(Iterator)]
//! let iter = match x {
//! 0 => Some(0).into_iter(),
//! _ => 0..x,
//! };
//! iter
//! }
//! ```
//!
//! * `loop`
//!
//! Wrap each `break` with a variant. Nested loops and labeled `break` are
//! also supported.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum(Iterator)]
//! fn expr_loop(mut x: i32) -> impl Iterator<Item = i32> {
//! loop {
//! if x < 0 {
//! break x..0;
//! } else if x % 5 == 0 {
//! break 0..=x;
//! }
//! x -= 1;
//! }
//! }
//! ```
//!
//! * `return` (in functions)
//!
//! `#[auto_enum]` can parse the `return` in the scope.
//!
//! This analysis is valid only when the return type is `impl Trait`.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! // return (in functions)
//! #[auto_enum(Iterator)]
//! fn func(x: i32) -> impl Iterator<Item=i32> {
//! if x == 0 {
//! return Some(0).into_iter();
//! }
//!
//! if x > 0 {
//! 0..x
//! } else {
//! x..=0
//! }
//! }
//! ```
//!
//! * `return` (in closures)
//!
//! `#[auto_enum]` can parse the `return` in the scope.
//!
//! This analysis is valid only when the following two conditions are satisfied.
//!
//! * `#[auto_enum]` must be used directly for that closure (or the let binding of the closure).
//! * `?` operator not used in the scope.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! // return (in closures)
//! #[auto_enum] // Nightly does not need an empty attribute to the function.
//! fn closure() -> impl Iterator<Item=i32> {
//! #[auto_enum(Iterator)]
//! let f = |x| {
//! if x == 0 {
//! return Some(0).into_iter();
//! }
//!
//! if x > 0 {
//! 0..x
//! } else {
//! x..=0
//! }
//! };
//! f(1)
//! }
//! ```
//!
//! * `?` operator (in functions)
//!
//! `#[auto_enum]` can parse the `?` operator in the scope.
//!
//! This analysis is valid only when the return type is `Result<T, impl Trait>`.
//!
//! ```rust
//! use auto_enums::auto_enum;
//! use std::fmt::{Debug, Display};
//!
//! // `?` operator (in functions)
//! #[auto_enum(Debug, Display)]
//! fn func(x: i32) -> Result<i32, impl Debug + Display> {
//! if x == 0 {
//! Err("`x` is zero")?;
//! }
//!
//! // The last branch of the function is not parsed.
//! if x < 0 {
//! Err(x)?
//! } else {
//! Ok(x + 1)
//! }
//! }
//! ```
//!
//! `?` operator is expanded as follows:
//!
//! ```rust
//! # enum Enum<A> { Veriant(A) }
//! # fn dox<T, E>(expr: Result<T, E>) -> Result<T, Enum<E>> {
//! # Ok(
//! match expr {
//! Ok(val) => val,
//! Err(err) => return Err(Enum::Veriant(err)),
//! }
//! # )
//! # }
//! ```
//!
//! * `?` operator (in closures)
//!
//! `#[auto_enum]` can parse the `?` operator in the scope.
//!
//! However, `#[auto_enum]` must be used directly for that closure
//! (or the let binding of the closure).
//!
//! ```rust
//! use auto_enums::auto_enum;
//! use std::fmt::{Debug, Display};
//!
//! // `?` operator (in closures)
//! #[auto_enum] // Nightly does not need an empty attribute to the function.
//! fn closure() -> Result<i32, impl Debug + Display> {
//! #[auto_enum(Debug, Display)]
//! let f = |x| {
//! if x == 0 {
//! Err("`x` is zero")?
//! }
//!
//! // The last branch of the function is not interpreted as a branch.
//! if x < 0 {
//! Err(x)?
//! } else {
//! Ok(x + 1)
//! }
//! };
//! f(1)
//! }
//! ```
//!
//! * Block, unsafe block, method call, parentheses, and type ascription
//!
//! The following expressions are recursively searched until an `if`, `match`,
//! `loop` or unsupported expression is found.
//!
//! * blocks
//! * unsafe blocks
//! * method calls
//! * parentheses
//! * type ascriptions
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! // block
//! #[auto_enum] // Nightly does not need an empty attribute to the function.
//! fn expr_block(x: i32) -> impl Iterator<Item=i32> {
//! #[auto_enum(Iterator)]
//! {
//! if x == 0 {
//! Some(0).into_iter()
//! } else {
//! 0..x
//! }
//! }
//! }
//!
//! // method call
//! #[auto_enum] // Nightly does not need an empty attribute to the function.
//! fn expr_method(x: i32) -> impl Iterator<Item=i32> {
//! #[auto_enum(Iterator)]
//! match x {
//! 0 => Some(0).into_iter(),
//! _ => 0..x,
//! }.map(|y| y + 1)
//! }
//!
//! // parentheses
//! # #[allow(unused_parens)]
//! #[auto_enum(Iterator)]
//! fn expr_parentheses(x: i32) -> impl Iterator<Item=i32> {
//! (if x == 0 { Some(0).into_iter() } else { 0..x })
//! }
//! ```
//!
//! ## Expression that no value will be returned
//!
//! If the last expression of a branch is one of the following, it is
//! interpreted that no value will be returned (variant assignment is skipped).
//!
//! * `panic!(..)`
//! * `unreachable!(..)`
//! * `return`
//! * `break`
//! * `continue`
//! * `None?`
//! * `Err(..)?`
//! * Expression level marker (`marker!` macro).
//! * An item definition.
//!
//! Also, if the branch contains `#[nested]`, it is interpreted as returning
//! an anonymous enum generated by `#[auto_enum]`, not a value.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum(Iterator)]
//! fn foo(x: i32) -> impl Iterator<Item = i32> {
//! match x {
//! 0 => 1..10,
//! 1 => panic!(), // variant assignment is skipped
//! _ => vec![5, 10].into_iter(),
//! }
//! }
//! ```
//!
//! You can also skip that branch explicitly by `#[never]` attribute.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum(Iterator)]
//! fn foo(x: i32) -> impl Iterator<Item = i32> {
//! match x {
//! 0 => 1..10,
//! #[never]
//! 1 => loop {
//! panic!()
//! },
//! _ => vec![5, 10].into_iter(),
//! }
//! }
//! ```
//!
//! ## Expression level marker (`marker!` macro)
//!
//! `#[auto_enum]` replaces `marker!` macros with variants.
//! If values of two or more are specified by `marker!` macros, `#[auto_enum]`
//! can be used for unsupported expressions and statements.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum(Iterator)]
//! fn foo(x: i32) -> impl Iterator<Item = i32> {
//! if x < 0 {
//! return x..=0;
//! }
//! marker!(1..10)
//! }
//! ```
//!
//! The default name of the macro is `"marker"`, but you can change it by
//! `marker` option.
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum(marker = bar, Iterator)]
//! fn foo(x: i32) -> impl Iterator<Item = i32> {
//! if x < 0 {
//! return x..=0;
//! }
//! bar!(1..10)
//! }
//! ```
//!
//! ## Rust Nightly
//!
//! When using `#[auto_enum]` for expressions and statements, `#[auto_enum]` for
//! function is unnecessary.
//!
//! ```rust
//! // Add this to your crate root:
//! #![feature(proc_macro_hygiene, stmt_expr_attributes)]
//! ```
//!
//! ```rust
//! # #![feature(proc_macro_hygiene, stmt_expr_attributes)]
//! use auto_enums::auto_enum;
//!
//! fn foo(x: i32) -> i32 {
//! #[auto_enum(Iterator)]
//! let iter = match x {
//! 0 => 1..10,
//! _ => vec![5, 10].into_iter(),
//! };
//!
//! iter.fold(0, |sum, x| sum + x)
//! }
//! ```
//!
//! You can also return closures.
//!
//! ```rust
//! // Add this to your crate root:
//! #![feature(fn_traits, unboxed_closures)]
//! ```
//!
//! ```rust
//! # #![feature(fn_traits, unboxed_closures)]
//! use auto_enums::auto_enum;
//!
//! #[auto_enum(Fn)]
//! fn foo(x: bool) -> impl Fn(i32) -> i32 {
//! if x { |y| y + 1 } else { |z| z - 1 }
//! }
//! ```
//!
//! # `#[enum_derive]`
//!
//! `#[enum_derive]` implements the supported traits and passes unsupported
//! traits to `#[derive]`.
//!
//! If you want to use traits that are not supported by `#[enum_derive]`, you
//! can use another crate that provides [derives macros][proc-macro-derive], or
//! you can define derives macros yourself ([derive_utils] probably can help it).
//!
//! Basic usage of `#[enum_derive]`
//!
//! ```rust
//! use auto_enums::enum_derive;
//!
//! // `#[enum_derive]` implements `Iterator`, and `#[derive]` implements `Clone`.
//! #[enum_derive(Iterator, Clone)]
//! enum Foo<A, B> {
//! A(A),
//! B(B),
//! }
//! ```
//!
//! `#[enum_derive]` adds the dependency of the specified trait if it is not
//! specified.
//!
//! ```rust
//! use auto_enums::enum_derive;
//!
//! // `#[enum_derive]` implements `Iterator` and `ExactSizeIterator`.
//! #[enum_derive(ExactSizeIterator)]
//! enum Foo<A, B> {
//! A(A),
//! B(B),
//! }
//! ```
//!
//! [derive_utils]: https://github.com/taiki-e/derive_utils
//!
//! # Supported traits
//!
//! Some traits support is disabled by default.
//! Note that some traits have aliases.
//!
//! *When using features that depend on unstable APIs, the `unstable` feature must be explicitly enabled*
//!
//! ## The standard library (`std`, `core`)
//!
//! ### `[std|core]::iter`
//!
//! * [`Iterator`](https://doc.rust-lang.org/std/iter/trait.Iterator.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/iter/iterator.md)
//! * [`DoubleEndedIterator`](https://doc.rust-lang.org/std/iter/trait.DoubleEndedIterator.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/iter/DoubleEndedIterator.md)
//! * [`ExactSizeIterator`](https://doc.rust-lang.org/std/iter/trait.ExactSizeIterator.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/iter/ExactSizeIterator.md)
//! * [`FusedIterator`](https://doc.rust-lang.org/std/iter/trait.FusedIterator.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/iter/FusedIterator.md)
//! * [`Extend`](https://doc.rust-lang.org/std/iter/trait.Extend.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/iter/extend.md)
//! * [`TrustedLen`](https://doc.rust-lang.org/std/iter/trait.TrustedLen.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/iter/TrustedLen.md) *(requires `"trusted_len"` and `"unstable"` crate features)*
//!
//! *See also [iter-enum] crate.*
//!
//! ### `[std|core]::future`
//!
//! * [`Future`](https://doc.rust-lang.org/std/future/trait.Future.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/future.md)
//!
//! *See also [futures-enum] crate.*
//!
//! ### `std::io` *(requires `"std"` crate feature)*
//!
//! * [`Read`](https://doc.rust-lang.org/std/io/trait.Read.html) (alias: `io::Read`) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/io/read.md)
//! * [`BufRead`](https://doc.rust-lang.org/std/io/trait.BufRead.html) (alias: `io::BufRead`) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/io/BufRead.md)
//! * [`Write`](https://doc.rust-lang.org/std/io/trait.Write.html) (alias: `io::Write`) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/io/write.md)
//! * [`Seek`](https://doc.rust-lang.org/std/io/trait.Seek.html) (alias: `io::Seek`) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/io/seek.md)
//!
//! *See also [io-enum] crate.*
//!
//! ### `[std|core]::ops`
//!
//! * [`Deref`](https://doc.rust-lang.org/std/ops/trait.Deref.html) *(requires `"ops"` crate feature)*
//! * [`DerefMut`](https://doc.rust-lang.org/std/ops/trait.DerefMut.html) *(requires `"ops"` crate feature)*
//! * [`Index`](https://doc.rust-lang.org/std/ops/trait.Index.html) *(requires `"ops"` crate feature)*
//! * [`IndexMut`](https://doc.rust-lang.org/std/ops/trait.IndexMut.html) *(requires `"ops"` crate feature)*
//! * [`RangeBounds`](https://doc.rust-lang.org/std/ops/trait.RangeBounds.html) *(requires `"ops"` crate feature)*
//! * [`Fn`](https://doc.rust-lang.org/std/ops/trait.Fn.html) *(requires `"fn_traits"` and `"unstable"` crate features)*
//! * [`FnMut`](https://doc.rust-lang.org/std/ops/trait.FnMut.html) *(requires `"fn_traits"` and `"unstable"` crate features)*
//! * [`FnOnce`](https://doc.rust-lang.org/std/ops/trait.FnOnce.html) *(requires `"fn_traits"` and `"unstable"` crate features)*
//! * [`Generator`](https://doc.rust-lang.org/nightly/std/ops/trait.Generator.html) *(requires `"generator_trait"` and `"unstable"` crate features)*
//!
//! ### `[std|core]::convert`
//!
//! * [`AsRef`](https://doc.rust-lang.org/std/convert/trait.AsRef.html) *(requires `"convert"` crate feature)*
//! * [`AsMut`](https://doc.rust-lang.org/std/convert/trait.AsMut.html) *(requires `"convert"` crate feature)*
//!
//! ### `[std|core]::fmt`
//!
//! * [`Debug`](https://doc.rust-lang.org/std/fmt/trait.Debug.html) (alias: `fmt::Debug`) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/debug.md)
//! * [`Display`](https://doc.rust-lang.org/std/fmt/trait.Display.html) (alias: `fmt::Display`)
//! * [`fmt::Binary`](https://doc.rust-lang.org/std/fmt/trait.Binary.html) *(requires `"fmt"` crate feature)*
//! * [`fmt::LowerExp`](https://doc.rust-lang.org/std/fmt/trait.LowerExp.html) *(requires `"fmt"` crate feature)*
//! * [`fmt::LowerHex`](https://doc.rust-lang.org/std/fmt/trait.LowerHex.html) *(requires `"fmt"` crate feature)*
//! * [`fmt::Octal`](https://doc.rust-lang.org/std/fmt/trait.Octal.html) *(requires `"fmt"` crate feature)*
//! * [`fmt::Pointer`](https://doc.rust-lang.org/std/fmt/trait.Pointer.html) *(requires `"fmt"` crate feature)*
//! * [`fmt::UpperExp`](https://doc.rust-lang.org/std/fmt/trait.UpperExp.html) *(requires `"fmt"` crate feature)*
//! * [`fmt::UpperHex`](https://doc.rust-lang.org/std/fmt/trait.UpperHex.html) *(requires `"fmt"` crate feature)*
//! * [`fmt::Write`](https://doc.rust-lang.org/std/fmt/trait.Write.html)
//!
//! ### `std::error` *(requires `"std"` crate feature)*
//!
//! * [`Error`](https://doc.rust-lang.org/std/error/trait.Error.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/std/error.md)
//!
//! ## External libraries
//!
//! You can use support for external library traits by activating each crate feature.
//!
//! To use support for external library traits, you need to use the path starting with the feature name. For example:
//!
//! ```rust
//! # extern crate rayon_crate as rayon;
//! use auto_enums::auto_enum;
//! use rayon::prelude::*;
//!
//! #[auto_enum(rayon::ParallelIterator)] // Note that this is not `#[auto_enum(ParallelIterator)]`
//! fn func(x: i32) -> impl ParallelIterator {
//! match x {
//! 0 => (1..10).into_par_iter(),
//! _ => vec![5, 10].into_par_iter(),
//! }
//! }
//! ```
//!
//! ### [futures v0.3][futures03] *(requires `"futures03"` or `"futures"` crate feature)*
//!
//! * [`futures03::Stream`](https://docs.rs/futures/0.3/futures/stream/trait.Stream.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/external/futures/stream.md)
//! * [`futures03::Sink`](https://docs.rs/futures/0.3/futures/sink/trait.Sink.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/external/futures/sink.md)
//! * [`futures03::AsyncRead`](https://docs.rs/futures/0.3/futures/io/trait.AsyncRead.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/external/futures/AsyncRead.md)
//! * [`futures03::AsyncWrite`](https://docs.rs/futures/0.3/futures/io/trait.AsyncWrite.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/external/futures/AsyncWrite.md)
//! * [`futures03::AsyncSeek`](https://docs.rs/futures/0.3/futures/io/trait.AsyncSeek.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/external/futures/AsyncSeek.md)
//! * [`futures03::AsyncBufRead`](https://docs.rs/futures/0.3/futures/io/trait.AsyncBufRead.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/external/futures/AsyncBufRead.md)
//!
//! *See also [futures-enum] crate.*
//!
//! ### [futures v0.1][futures01] *(requires `"futures01"` crate feature)*
//!
//! * [`futures01::Future`](https://docs.rs/futures/0.1/futures/future/trait.Future.html)
//! * [`futures01::Stream`](https://docs.rs/futures/0.1/futures/stream/trait.Stream.html)
//! * [`futures01::Sink`](https://docs.rs/futures/0.1/futures/sink/trait.Sink.html)
//!
//! ### [rayon] *(requires `"rayon"` crate feature)*
//!
//! * [`rayon::ParallelIterator`](https://docs.rs/rayon/1/rayon/iter/trait.ParallelIterator.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/external/rayon/ParallelIterator.md)
//! * [`rayon::IndexedParallelIterator`](https://docs.rs/rayon/1/rayon/iter/trait.IndexedParallelIterator.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/external/rayon/IndexedParallelIterator.md)
//! * [`rayon::ParallelExtend`](https://docs.rs/rayon/1/rayon/iter/trait.ParallelExtend.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/external/rayon/ParallelExtend.md)
//!
//! ### [serde] *(requires `"serde"` crate feature)*
//!
//! * [`serde::Serialize`](https://docs.rs/serde/1/serde/trait.Serialize.html) - [generated code](https://github.com/taiki-e/auto_enums/blob/master/docs/supported_traits/external/serde/serialize.md)
//!
//! ### [tokio v1][tokio1] *(requires `"tokio1"` crate feature)*
//!
//! * [`tokio1::AsyncRead`](https://docs.rs/tokio/1/tokio/io/trait.AsyncRead.html)
//! * [`tokio1::AsyncWrite`](https://docs.rs/tokio/1/tokio/io/trait.AsyncWrite.html)
//! * [`tokio1::AsyncSeek`](https://docs.rs/tokio/1/tokio/io/trait.AsyncSeek.html)
//! * [`tokio1::AsyncBufRead`](https://docs.rs/tokio/1/tokio/io/trait.AsyncBufRead.html)
//!
//! ### [tokio v0.3][tokio03] *(requires `"tokio03"` crate feature)*
//!
//! * [`tokio03::AsyncRead`](https://docs.rs/tokio/0.3/tokio/io/trait.AsyncRead.html)
//! * [`tokio03::AsyncWrite`](https://docs.rs/tokio/0.3/tokio/io/trait.AsyncWrite.html)
//! * [`tokio03::AsyncSeek`](https://docs.rs/tokio/0.3/tokio/io/trait.AsyncSeek.html)
//! * [`tokio03::AsyncBufRead`](https://docs.rs/tokio/0.3/tokio/io/trait.AsyncBufRead.html)
//!
//! ### [tokio v0.2][tokio02] *(requires `"tokio02"` crate feature)*
//!
//! * [`tokio02::AsyncRead`](https://docs.rs/tokio/0.2/tokio/io/trait.AsyncRead.html)
//! * [`tokio02::AsyncWrite`](https://docs.rs/tokio/0.2/tokio/io/trait.AsyncWrite.html)
//! * [`tokio02::AsyncSeek`](https://docs.rs/tokio/0.2/tokio/io/trait.AsyncSeek.html)
//! * [`tokio02::AsyncBufRead`](https://docs.rs/tokio/0.2/tokio/io/trait.AsyncBufRead.html)
//!
//! ### [tokio v0.1][tokio01] *(requires `"tokio01"` crate feature)*
//!
//! * [`tokio01::AsyncRead`](https://docs.rs/tokio/0.1/tokio/io/trait.AsyncRead.html)
//! * [`tokio01::AsyncWrite`](https://docs.rs/tokio/0.1/tokio/io/trait.AsyncWrite.html)
//!
//! ## Inherent methods
//!
//! These don't derive traits, but derive inherent methods instead.
//!
//! * `Transpose` *(requires `"transpose_methods"` crate feature)* - this derives the following conversion methods.
//!
//! * `transpose` — convert from `enum<Option<T1>,..>` to `Option<enum<T1,..>>`
//!
//! * `transpose` — convert from `enum<Result<T1, E1>,..>` to `Result<enum<T1,..>, enum<E1,..>>`
//!
//! * `transpose_ok` — convert from `enum<Result<T1, E>,..>` to `Option<enum<T1,..>, E>`
//!
//! Examples:
//!
//! ```rust
//! use auto_enums::auto_enum;
//! use std::{fs, io, path::Path};
//!
//! #[auto_enum(Transpose, Write)]
//! fn output_stream(file: Option<&Path>) -> io::Result<impl io::Write> {
//! match file {
//! Some(f) => fs::File::create(f),
//! None => Ok(io::stdout()),
//! }.transpose_ok()
//! }
//! ```
//!
//! * `transpose_err` — convert from `enum<Result<T, E1>,..>` to `Result<T, enum<E1,..>>`
//!
//! # Optional features
//!
//! * **`std`** *(enabled by default)*
//! * Enable to use `std` library's traits.
//! * **`ops`**
//! * Enable to use `[std|core]::ops`'s `Deref`, `DerefMut`, `Index`, `IndexMut`, and `RangeBounds` traits.
//! * **`convert`**
//! * Enable to use `[std|core]::convert`'s `AsRef` and `AsMut` traits.
//! * **`fmt`**
//! * Enable to use `[std|core]::fmt`'s traits other than `Debug`, `Display` and `Write`.
//! * **`transpose_methods`**
//! * Enable to use `transpose*` methods.
//! * **`futures03`**
//! * Enable to use [futures v0.3][futures03] traits.
//! * **`futures01`**
//! * Enable to use [futures v0.1][futures01] traits.
//! * **`rayon`**
//! * Enable to use [rayon] traits.
//! * **`serde`**
//! * Enable to use [serde] traits.
//! * **`tokio1`**
//! * Enable to use [tokio v1][tokio1] traits.
//! * **`tokio03`**
//! * Enable to use [tokio v0.3][tokio03] traits.
//! * **`tokio02`**
//! * Enable to use [tokio v0.2][tokio02] traits.
//! * **`tokio01`**
//! * Enable to use [tokio v0.1][tokio01] traits.
//! * **`generator_trait`**
//! * Enable to use `[std|core]::ops::Generator` trait.
//! * Note that this feature is unstable and may cause incompatible changes between patch versions.
//! * **`fn_traits`**
//! * Enable to use `[std|core]::ops`'s `Fn`, `FnMut`, and `FnOnce` traits.
//! * Note that this feature is unstable and may cause incompatible changes between patch versions.
//! * **`trusted_len`**
//! * Enable to use `[std|core]::iter::TrustedLen` trait.
//! * Note that this feature is unstable and may cause incompatible changes between patch versions.
//!
//! ## `type_analysis` feature
//!
//! Analyze return type of function and `let` binding.
//!
//! *Note that this feature is still experimental.*
//!
//! Examples:
//!
//! ```rust
//! use auto_enums::auto_enum;
//!
//! #[auto_enum] // there is no need to specify std library's traits
//! fn func1(x: i32) -> impl Iterator<Item = i32> {
//! match x {
//! 0 => 1..10,
//! _ => vec![5, 10].into_iter(),
//! }
//! }
//!
//! #[auto_enum]
//! fn func2(x: i32) {
//! // Unlike `feature(impl_trait_in_bindings)`, this works on stable compilers.
//! #[auto_enum]
//! let iter: impl Iterator<Item = i32> = match x {
//! 0 => Some(0).into_iter(),
//! _ => 0..x,
//! };
//! }
//! ```
//!
//! Please be careful if you return another traits with the same name.
//!
//! # Known limitations
//!
//! * There needs to explicitly specify the trait to be implemented (`type_analysis` crate feature reduces this limitation).
//! * There needs to be marker macros for unsupported expressions.
//!
//! [derive_utils]: https://github.com/taiki-e/derive_utils
//! [futures-enum]: https://github.com/taiki-e/futures-enum
//! [futures01]: https://docs.rs/futures/0.1
//! [futures03]: https://docs.rs/futures/0.3
//! [io-enum]: https://github.com/taiki-e/io-enum
//! [iter-enum]: https://github.com/taiki-e/iter-enum
//! [proc-macro-derive]: https://doc.rust-lang.org/reference/procedural-macros.html#derive-macros
//! [rayon]: https://docs.rs/rayon/1
//! [serde]: https://docs.rs/serde/1
//! [tokio01]: https://docs.rs/tokio/0.1
//! [tokio02]: https://docs.rs/tokio/0.2
//! [tokio03]: https://docs.rs/tokio/0.3
//! [tokio1]: https://docs.rs/tokio/1
#![no_std]
#![doc(test(
no_crate_inject,
attr(
deny(warnings, rust_2018_idioms, single_use_lifetimes),
allow(dead_code, unused_variables)
)
))]
#![forbid(unsafe_code)]
#![warn(future_incompatible, rust_2018_idioms, single_use_lifetimes, unreachable_pub)]
#![warn(clippy::all, clippy::default_trait_access)]
#[cfg(all(feature = "generator_trait", not(feature = "unstable")))]
compile_error!(
"The `generator_trait` feature requires the `unstable` feature as an explicit opt-in to unstable features"
);
#[cfg(all(feature = "fn_traits", not(feature = "unstable")))]
compile_error!(
"The `fn_traits` feature requires the `unstable` feature as an explicit opt-in to unstable features"
);
#[cfg(all(feature = "trusted_len", not(feature = "unstable")))]
compile_error!(
"The `trusted_len` feature requires the `unstable` feature as an explicit opt-in to unstable features"
);
#[doc(inline)]
pub use auto_enums_core::auto_enum;
#[doc(inline)]
pub use auto_enums_derive::enum_derive;