Difference between revisions of "Conversion Module"
Jump to navigation
Jump to search
Line 16: | Line 16: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Converts the specifed binary data (xs:base64Binary, xs:hexBinary) to a string: | + | |Converts the specifed binary data ({{Code|xs:base64Binary}}, {{Code|xs:hexBinary}}) to a string: |
* The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument. | * The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument. | ||
* By default, invalid characters will be rejected. If {{Code|$fallback}} is set to true, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (�). | * By default, invalid characters will be rejected. If {{Code|$fallback}} is set to true, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (�). | ||
Line 107: | Line 107: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns the specified binary data (xs:base64Binary, xs:hexBinary) as a sequence of bytes. | + | |Returns the specified binary data ({{Code|xs:base64Binary}}, {{Code|xs:hexBinary}}) as a sequence of bytes. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 125: | Line 125: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns the specified binary data (xs:base64Binary, xs:hexBinary) as a sequence of unsigned integers (octets). | + | |Returns the specified binary data ({{Code|xs:base64Binary}}, {{Code|xs:hexBinary}}) as a sequence of unsigned integers (octets). |
|- | |- | ||
| '''Examples''' | | '''Examples''' |
Revision as of 17:56, 24 August 2017
This XQuery Module contains functions to convert data between different formats.
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.
Strings
convert:binary-to-string
Signatures | convert:binary-to-string($bytes as xs:anyAtomicType) as xs:string convert:binary-to-string($bytes as xs:anyAtomicType, $encoding as xs:string) as xs:string convert:binary-to-string($bytes as xs:anyAtomicType, $encoding as xs:string, $fallback as xs:boolean) as xs:string
|
Summary | Converts the specifed binary data (xs:base64Binary , xs:hexBinary ) to a string:
|
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:string-to-base64
Signatures | convert:string-to-base64($input as xs:string) as xs:base64Binary convert:string-to-base64($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 cheap, as both xs:string and xs:base64Binary items are internally represented as 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:string-to-hex
Signatures | convert:string-to-hex($input as xs:string) as xs:hexBinary convert:string-to-hex($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 cheap, as both xs:string and xs:hexBinary items are internally represented as 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 |
|
Binary Data
convert:bytes-to-base64
Template:Mark: Argument type relaxed from xs:byte
to xs:integer
.
Signatures | convert:bytes-to-base64($input as xs:integer*) as xs:base64Binary
|
Summary | Converts the specified integer sequence to a xs:base64Binary item:
|
Errors | BXCO0001 : The input cannot be represented in the specified encoding.BXCO0002 : The specified encoding is invalid or not supported.
|
convert:bytes-to-hex
Template:Mark: Argument type relaxed from xs:byte
to xs:integer
.
Signatures | convert:bytes-to-hex($input as xs:integer*) as xs:hexBinary
|
Summary | Converts the specified integer sequence to a xs:hexBinary item:
|
convert:binary-to-bytes
Signatures | convert:binary-to-bytes($bin as xs:anyAtomicType) as xs:byte*
|
Summary | Returns the specified binary data (xs:base64Binary , xs:hexBinary ) as a sequence of bytes.
|
Examples |
|
convert:binary-to-integer
Signatures | convert:binary-to-integer($bin as xs:anyAtomicType) as xs:integer*
|
Summary | Returns the specified binary data (xs:base64Binary , xs:hexBinary ) as a sequence of unsigned integers (octets).
|
Examples |
|
Numbers
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 . |
Errors | BXCO0004 : The specified base is not in the range 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.
|
Errors | BXCO0004 : The specified base is not in the range 2-36.BXCO0005 : The specified digit is not valid for the given range.
|
Examples |
|
Dates and Durations
convert:integer-to-dateTime
Signatures | convert:integer-to-dateTime($ms as xs:integer) as xs:dateTime |
Summary | Converts the specified number of milliseconds since 1 Jan 1970 to an item of type xs:dateTime. |
Examples |
|
convert:dateTime-to-integer
Signatures | convert:dateTime-to-integer($dateTime as xs:dateTime) as xs:integer |
Summary | Converts the specified item of type xs:dateTime to the number of milliseconds since 1 Jan 1970. |
Examples |
|
convert:integer-to-dayTime
Signatures | convert:integer-to-dayTime($ms as xs:integer) as xs:dayTimeDuration |
Summary | Converts the specified number of milliseconds to an item of type xs:dayTimeDuration. |
Examples |
|
convert:dayTime-to-integer
Signatures | convert:dayTime-to-integer($dayTime as xs:dayTimeDuration) as xs:integer |
Summary | Converts the specified item of type xs:dayTimeDuration to milliseconds represented by an integer. |
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. |
BXCO0003
|
The specified base is not in the range 2-36. |
BXCO0004
|
The specified encoding is invalid or not supported. |
BXCO0005
|
The specified digit is not valid for the given range. |
Changelog
- Version 8.7
- Added: convert:bytes-to-integer.
- Updated: convert:bytes-to-base64, convert:bytes-to-hex: Argument type relaxed from
xs:byte
toxs:integer
.
- Version 8.5
- Updated: convert:binary-to-string:
$fallback
argument added.
- Version 7.5
- Added: convert:integer-to-dateTime, convert:dateTime-to-integer, convert:integer-to-dayTime, convert:dayTime-to-integer.
The module was introduced with Version 7.3. Some of the functions have been adopted from the obsolete Utility Module.