View source code Display the source code in std/xml.d from which this page was generated on github. Improve this page Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone. Page wiki View or edit the community-maintained wiki page associated with this page.

Function std.xml.encode

Encodes a string by replacing all characters which need to be escaped with appropriate predefined XML entities.

encode() escapes certain characters (ampersand, quote, apostrophe, less-than and greater-than), and similarly, decode() unescapes them. These functions are provided for convenience only. You do not need to use them when using the std.xml classes, because then all the encoding and decoding will be done for you automatically.

If the string is not modified, the original will be returned.

Prototype

S encode(S)(
  S s
);

Standards

XML 1.0

Parameters

NameDescription
s The string to be encoded

Returns

The encoded string

Examples

writefln(encode("a > b")); // writes "a > b"

Authors

Janice Caron

License

Boost License 1.0.

Comments