Sprout/source/libs/string/char_traits/copy.rst

.. _sprout-string-char_traits-copy:
###############################################################################
copy
###############################################################################

Interface
========================================
.. sourcecode:: c++

  static SPROUT_CXX14_CONSTEXPR char_type* copy(char_type* s1, char_type const* s2, std::size_t n);

Pre-condition
========================================

| s2 not in [s1,s1+n).

Effects
========================================

| Equivalent to ``std::char_traits<Char>::copy(s1, s2, n)``.

Examples
========================================
.. sourcecode:: c++

  #include <sprout/string.hpp>
  #include <sprout/assert.hpp>
  using namespace sprout;
  
  char x[] = "homuhomu";
  SPROUT_STATIC_CONSTEXPR char const* y = "madocchi";
  int main() {
    char_traits<char>::copy(x, y, 8);
    SPROUT_ASSERT_MSG(x[0] == y[0], "y is copied to x.");
  }

Complexity
========================================

| linear.

Header
========================================

| ``sprout/string/char_traits.hpp``
| Convenience header: ``sprout/string.hpp``