tuplities-replicate 0.1.4

A trait for replicating values into tuples
Documentation 
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

#![no_std]

//! [tuplities](https://github.com/lucacappelletti94/tuplities) suite crate providing the `TupleReplicate` trait.

#[tuplities_derive::impl_tuple_replicate]
/// A trait for replicating a value into a tuple.
///
/// This trait allows creating a tuple where all elements are the same value.
/// The implementation is optimized to avoid unnecessary cloning: for empty tuples
/// and single-element tuples, no `Clone` bound is required. For tuples with 2+
/// elements, `Clone` is required but the original value is moved to the last
/// position to minimize clones.
///
/// Part of the [`tuplities`](https://docs.rs/tuplities/latest/tuplities/) crate.
pub trait TupleReplicate<T> {
    /// Creates a tuple where all elements are the provided value.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use tuplities_replicate::TupleReplicate;
    ///
    /// let tuple: (i32, i32, i32) = TupleReplicate::tuple_replicate(42);
    /// assert_eq!(tuple, (42, 42, 42));
    /// let _tuple_empty: () = TupleReplicate::tuple_replicate(42);
    /// let tuple_single: (i32,) = TupleReplicate::tuple_replicate(42);
    /// assert_eq!(tuple_single, (42,));
    /// let tuple_two: (i32, i32) = TupleReplicate::tuple_replicate(42);
    /// assert_eq!(tuple_two, (42, 42));
    ///
    /// let tuple_refs: (&str, &str, &str) = TupleReplicate::tuple_replicate("hello");
    /// assert_eq!(tuple_refs, ("hello", "hello", "hello"));
    ///
    /// let tuple_strings: (String, String) = TupleReplicate::tuple_replicate(String::from("world"));
    /// assert_eq!(tuple_strings, (String::from("world"), String::from("world")));
    ///
    /// let tuple_refs2: (&i32, &i32) = TupleReplicate::tuple_replicate(&100);
    /// assert_eq!(tuple_refs2, (&100, &100));
    /// ```
    fn tuple_replicate(value: T) -> Self;
}