# 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.

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

produces

    "##foo bar##"

### Syntax 2

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

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

produces

    "'foo_bar'"

Support: rsyslog Assistant | GitHub Discussions | GitHub Issues: rsyslog source project

Contributing: Source & docs: rsyslog source project

© 2008–2025 Rainer Gerhards and others. Licensed under the Apache License 2.0.