Function std.xml.decode
Decodes a string by unescaping all 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.
This function decodes the entities &, ", ', < and >, as well as decimal and hexadecimal entities such as €
If the string does not contain an ampersand, the original will be returned.
Note that the "mode
" parameter can be one of DecodeMode.NONE (do not
decode
), DecodeMode.LOOSE (decode
, but ignore errors), or DecodeMode.STRICT
(decode
, and throw a DecodeException
in the event of an error).
Prototype
string decode( string s, DecodeMode mode = cast(DecodeMode)1 );
Standards
Parameters
Name | Description |
---|---|
s | The string to be decoded |
mode | (optional) Mode to use for decoding. (Defaults to LOOSE). |
Throws
DecodeException
if mode
== DecodeMode.STRICT and decode
fails
Returns
The decoded string
Examples
writefln(decode("a > b")); // writes "a > b"
Authors
Janice Caron