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

// Copyright (c) 2017-2018 FaultyRAM
//
// 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.

//! Macros for concatenating string slices into owned strings.
//!
//! This crate provides the `concat_string!` macro for efficiently concatenating string slices into
//! owned strings. `concat_string!` accepts any number of arguments that implement `AsRef<str>` and
//! creates a `String` with the appropriate capacity, without the need for format strings and their
//! associated runtime overhead.
//!
//! # Example
//!
//! ```rust
//! #[macro_use(concat_string)]
//! extern crate concat_string;
//!
//! fn main() {
//!     println!("{}", concat_string!("Hello", String::from(" "), "world"));
//! }
//! ```

#![forbid(warnings)]
#![forbid(unused)]
#![forbid(box_pointers)]
#![forbid(missing_copy_implementations)]
#![forbid(missing_debug_implementations)]
#![forbid(missing_docs)]
#![forbid(trivial_casts)]
#![forbid(trivial_numeric_casts)]
#![forbid(unsafe_code)]
#![forbid(unused_extern_crates)]
#![forbid(unused_import_braces)]
#![forbid(unused_qualifications)]
#![forbid(unused_results)]
#![forbid(variant_size_differences)]
#![cfg_attr(feature = "cargo-clippy", forbid(clippy))]
#![cfg_attr(feature = "cargo-clippy", forbid(clippy_pedantic))]
#![cfg_attr(feature = "cargo-clippy", forbid(clippy_cargo))]
#![cfg_attr(feature = "cargo-clippy", forbid(clippy_complexity))]
#![cfg_attr(feature = "cargo-clippy", forbid(clippy_correctness))]
#![cfg_attr(feature = "cargo-clippy", forbid(clippy_perf))]
#![cfg_attr(feature = "cargo-clippy", forbid(clippy_style))]

#[macro_export]
/// Concatenates a series of string slices into an owned string.
///
/// This macro accepts zero or more arguments, where each argument implements `AsRef<str>`, and
/// efficiently combines their string representations into a `String` in order of declaration.
///
/// This is mainly useful for cases where the cost of parsing a format string outweighs the cost
/// of converting its arguments. Because `concat_string` avoids format strings entirely, it can
/// achieve a higher level of performance than using `format!` or other formatting utilities that
/// return a `String`.
///
/// # Example
///
/// ```rust
/// #[macro_use(concat_string)]
/// extern crate concat_string;
///
/// fn main() {
///     println!("{}", concat_string!("Hello", String::from(" "), "world"));
/// }
/// ```
macro_rules! concat_string {
    () => { String::with_capacity(0) };
    ($($s:expr),+) => {{
        use std::ops::AddAssign;
        let mut len = 0;
        $(len.add_assign(AsRef::<str>::as_ref(&$s).len());)+
        let mut buf = String::with_capacity(len);
        $(buf.push_str($s.as_ref());)+
        buf
    }};
}

#[cfg(test)]
mod tests {
    #[test]
    fn concat_string_0_args() {
        let s = concat_string!();
        assert_eq!(s, String::from(""));
    }

    #[test]
    fn concat_string_1_arg() {
        let s = concat_string!("foo");
        assert_eq!(s, String::from("foo"));
    }

    #[test]
    fn concat_string_str_string() {
        let s = concat_string!("foo", String::from("bar"));
        assert_eq!(s, String::from("foobar"));
    }
}