summaryrefslogtreecommitdiffstats
path: root/source/rainerscript/functions/rs-wrap.rst
blob: d1dbd1cbed86b2ec4d07e638965c7c86d97ad4f0 (plain)
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
******
wrap()
******

Purpose
=======

wrap(str, wrapper_str)
wrap(str, wrapper_str, escaper_str)

Returns the str wrapped with wrapper_str.
In the second syntax additionally, any instances of wrapper_str appearing
in str would be replaced by the escaper_str.


Example
=======

Syntax 1
--------

The following example shows how the string is wrapped into
the wrapper_string.

.. code-block:: none

   wrap("foo bar", "##")

produces

.. code-block:: none

   "##foo bar##"


Syntax 2
--------

This example shows how parts of the string are being replaced.

.. code-block:: none

   wrap("foo'bar", "'", "_")

produces

.. code-block:: none

   "'foo_bar'"