| // Copyright 2012 The Rust Project Developers. See the COPYRIGHT |
| // file at the top-level directory of this distribution and at |
| // http://rust-lang.org/COPYRIGHT. |
| // |
| // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license |
| // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your |
| // option. This file may not be copied, modified, or distributed |
| // except according to those terms. |
| |
| //! Operations on tuples |
| //! |
| //! To access the _N_-th element of a tuple one can use `N` itself |
| //! as a field of the tuple. |
| //! |
| //! Indexing starts from zero, so `0` returns first value, `1` |
| //! returns second value, and so on. In general, a tuple with _S_ |
| //! elements provides aforementioned fields from `0` to `S-1`. |
| //! |
| //! If every type inside a tuple implements one of the following |
| //! traits, then a tuple itself also implements it. |
| //! |
| //! * `Clone` |
| //! * `PartialEq` |
| //! * `Eq` |
| //! * `PartialOrd` |
| //! * `Ord` |
| //! * `Default` |
| //! |
| //! # Examples |
| //! |
| //! Accessing elements of a tuple at specified indices: |
| //! |
| //! ``` |
| //! let x = ("colorless", "green", "ideas", "sleep", "furiously"); |
| //! assert_eq!(x.3, "sleep"); |
| //! |
| //! let v = (3, 3); |
| //! let u = (1, -5); |
| //! assert_eq!(v.0 * u.0 + v.1 * u.1, -12); |
| //! ``` |
| //! |
| //! Using traits implemented for tuples: |
| //! |
| //! ``` |
| //! let a = (1, 2); |
| //! let b = (3, 4); |
| //! assert!(a != b); |
| //! |
| //! let c = b.clone(); |
| //! assert!(b == c); |
| //! |
| //! let d : (u32, f32) = Default::default(); |
| //! assert_eq!(d, (0, 0.0f32)); |
| //! ``` |
| |
| #![doc(primitive = "tuple")] |
| #![stable(feature = "rust1", since = "1.0.0")] |
