Difference between revisions of "Conversion Module"
Jump to navigation
Jump to search
Line 123: | Line 123: | ||
=Changelog= | =Changelog= | ||
− | The module was introduced with Version 7.3. Some of the functions have been | + | The module was introduced with Version 7.3. Some of the functions have been adopted from the [[Utility Module]]. |
[[Category:XQuery]] | [[Category:XQuery]] |
Revision as of 17:43, 27 May 2012
This XQuery Module contains functions to convert data between different formats.
Contents
Conventions
All functions in this module are assigned to the http://basex.org/modules/convert
namespace, which is statically bound to the convert
prefix.
All errors are assigned to the http://basex.org/errors
namespace, which is statically bound to the bxerr
prefix.
Binary Data
convert:to-string
Signatures | convert:to-string($bytes as basex:binary) as xs:string convert:to-string($bytes as basex:binary, $encoding as xs:string) as xs:string
|
Summary | Converts the specifed binary data (xs:base64Binary , xs:hexBinary ) to a string.The UTF-8 default encoding can be overwritten with the optional $encoding argument.
|
Errors | BXCO0001 : The input is an invalid XML string, or the wrong encoding has been specified.BXCO0002 : The specified encoding is invalid or not supported.
|
Examples |
|
convert:to-base64Binary
Signatures | convert:to-base64Binary($input as xs:string) as xs:base64Binary convert:to-base64Binary($input as xs:string, $encoding as xs:string) as xs:base64Binary
|
Summary | Converts the specified string to a xs:base64Binary item. If the default encoding is chosen, conversion will be very cheap in BaseX, as both xs:string and xs:base64Binary items are internally mapped to byte arrays.The UTF-8 default encoding can be overwritten with the optional $encoding argument.
|
Errors | BXCO0001 : The input cannot be represented in the specified encoding.BXCO0002 : The specified encoding is invalid or not supported.
|
Examples |
|
convert:to-hexBinary
Signatures | convert:to-hexBinary($input as xs:string) as xs:hexBinary convert:to-hexBinary($input as xs:string, $encoding as xs:string) as xs:hexBinary
|
Summary | Converts the specified string to a xs:hexBinary item. If the default encoding is chosen, conversion will be very cheap in BaseX, as both xs:string and xs:hexBinary items are internally mapped to byte arrays.The UTF-8 default encoding can be overwritten with the optional $encoding argument.
|
Errors | BXCO0001 : The input cannot be represented in the specified encoding.BXCO0002 : The specified encoding is invalid or not supported.
|
Examples |
|
convert:to-bytes
Signatures | convert:to-bytes($bin as basex:binary) as xs:byte*
|
Summary | Extracts the bytes from the given binary data $bin .
|
Examples |
|
Numeric Data
convert:integer-to-base
Signatures | convert:integer-to-base($num as xs:integer, $base as xs:integer) as xs:string |
Summary | Converts $num to base $base , interpreting it as a 64-bit unsigned integer.The first $base elements of the sequence '0',..,'9','a',..,'z' are used as digits.Valid bases are 2, .., 36 . |
Examples |
|
convert:integer-from-base
Signatures | convert:integer-from-base($str as xs:string, $base as xs:integer) as xs:integer |
Summary | Decodes an xs:integer from $str , assuming that it's encoded in base $base .The first $base elements of the sequence '0',..,'9','a',..,'z' are allowed as digits, case doesn't matter. Valid bases are 2 - 36. If $str contains more than 64 bits of information, the result is truncated arbitarily.
|
Examples |
|
Errors
Code | Description |
---|---|
BXCO0001
|
The input is an invalid XML string, or the wrong encoding has been specified. |
BXCO0002
|
The specified encoding is invalid or not supported. |
Changelog
The module was introduced with Version 7.3. Some of the functions have been adopted from the Utility Module.