BinaryEncode()

edit

Converts binary data to a string.

BinaryEncode( binary=binary, encoding=string );

Returns: String

Argument Description
binary
binary, required
edit

A variable containing the binary data to encode.

Alias: binaryData

encoding
string, required
edit

A string that specifies the encoding method to use to represent the data; one of the following:

  • Hex: use the characters 0-9 and A-F to represent the hexadecimal value of each byte.
  • UU: use the UNIX UUencode algorithm to convert the data
  • Base64: use the Base64 algorithm to convert the data, as specified by IETF RFC 2045, at www.ietf.org/rfc/rfc2045.txt.
  • Base64URL: use the URL and filename safe Base64 alphabet (- and _ instead of + and /) without padding, as specified by IETF RFC 4648 section 5, at www.ietf.org/rfc/rfc4648.txt. This is the encoding used by JWT, OAuth and PKCE.

Examples

edit
base_64 = ToBase64("I am a string.");
binary_data = ToBinary(base_64);
dump(BinaryEncode(binary_data, "hex")); // 4920616D206120737472696E672E
<div class="highlight"><pre><span></span>
</pre></div>
<br>luceescript+trycf
// Base64URL as used by JWT: URL safe alphabet (- and _) and no padding
binary_data = BinaryDecode("FBFFFE", "hex");
dump(BinaryEncode(binary_data, "base64"));    // +//+
dump(BinaryEncode(binary_data, "base64url")); // -__-
dump(BinaryEncode(BinaryDecode("66", "hex"), "base64url")); // Zg

See also