Module : encoding
Module overview
This module provides the necessary utilities that are required to encode and decode content using different encoding mechanisms and algorithms.
Encoding byte array to hex string
The encodeHex
function encodes provided byte array to an hex string
.
Decoding hex string to byte array
The decodeHex
function decodes a hex encoded string
to a byte array.
Encoding byte array to base64 string
The encodeBase64
function encodes provided byte array to an base64 string
.
Decoding base64 string to byte array
The decodeBase64
function decodes a base64 encoded string
to a byte array.
Encoding byte array into a string
The byteArrayToString
function can be used to encode a byte array into a string using a provided charset.
Samples
import ballerina/encoding;
import ballerina/io;
public function main() returns error? {
string charEncoding = "UTF-8";
// The string content to be hashed.
string text = "Hello Ballerina";
byte[] inputByteArr = input.toByteArray(charEncoding);
string output = encoding:encodeHex(inputByteArr)
io:println("Hex encoded string : " + output);
// Hex encoded string, decoded back into a byte array.
inputByteArr = check encoding:decodeHex(output)
output = encoding:encodeBase64(inputByteArr)
io:println("Base64 encoded string : " + output);
// Base64 encoded string, decoded back into a byte array.
inputByteArr = check encoding:decodeBase64(output)
// Convert byte array into a string.
string finalString = encoding:byteArrayToString(inputByteArr);
}
byteArrayToString | Converts given byte array to a string. |
decodeBase64 | Decode Base64 encoded |
decodeBase64Url | Decode Base64 URL encoded |
decodeHex | Decode Hex encoded |
encodeBase64 | Returns the Base64 encoded |
encodeBase64Url | Returns the Base64 URL encoded |
encodeHex | Returns the Hex encoded |
ENCODING_ERROR |
EncodingError |