> For the complete documentation index, see [llms.txt](https://docs.atom.codes/sprout/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.atom.codes/sprout/~/changes/gP9HOVz2PoFWbplTHwVo/registries/encoding.md). # Encoding {% hint style="info" %} You can easily import all the functions from the `encoding` registry by including the following import statement in your code ```go import "github.com/go-sprout/sprout/registry/encoding" ``` {% endhint %} ### base64Encode The function encodes a given string into its Base64 representation, converting the data into a text format suitable for transmission or storage in systems that support Base64 encoding.

Name	Value
Signature	`Base64Encode(s string) string`
Must version	❌

{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World" | base64Encode }} // Output: "SGVsbG8gV29ybGQ=" ``` {% endtab %} {% endtabs %} ### base64Decode The function decodes a Base64 encoded string back to its original form. If the input string is not valid Base64, it returns an error message.

Name	Value
Signature	`Base64Decode(s string) string`
Must version	❌

{% tabs %} {% tab title="Template Example" %} ```go {{ "SGVsbG8gV29ybGQ=" | base64Decode }} // Output: "Hello World" ``` {% endtab %} {% endtabs %} ### base32Encode The function encodes a given string into its Base32 representation, converting the data into a text format that is compatible with systems supporting Base32 encoding.

Name	Value
Signature	`Base32Encode(s string) string`
Must version	❌

{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World" | base32Encode }} // Output: "JBSWY3DPEBLW64TMMQQQ====" ``` {% endtab %} {% endtabs %} ### base32Decode The function decodes a Base32 encoded string back to its original form. If the input is not valid Base32, it returns an error message.

Name	Value
Signature	`Base32Decode(s string) string`
Must version	❌

{% tabs %} {% tab title="Template Example" %} ```go {{ "JBSWY3DPEBLW64TMMQQQ====" | base32Decode }} // Output: "Hello World" ``` {% endtab %} {% endtabs %} ### fromJson / mustFromJson The function converts a JSON string into a corresponding Go data structure, enabling easy manipulation of the JSON data in a Go environment.

Name	Value
Signature	`FromJson(v string) any MustFromJson(v string) (any, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ '{"name":"John", "age":30}' | fromJson }} // Output: map[name:John age:30] ``` {% endtab %} {% tab title="Must version" %} ```go {{ '{"name":"John", "age":30}' | mustFromJson }} // Output: map[name:John age:30], nil {{ '{\invalid' | mustFromJson }} // Output: nil, error ``` {% endtab %} {% endtabs %} ### toJson / mustToJson The function converts a Go data structure into a JSON string, allowing the data to be easily serialized for storage, transmission, or further processing.

Name	Value
Signature	`ToJson(v any) string MustToJson(v any) (string, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ $d := dict "key1" "value1" "key2" "value2" "key3" "value3" }} {{ toJson $d }} // Output: {"key1":"value1","key2":"value2","key3":"value3"} ``` {% endtab %} {% tab title="Must version" %} ```go {{ $d := dict "key1" "value1" "key2" "value2" "key3" "value3" }} {{ mustToJson $d }} // Output: {"key1":"value1","key2":"value2","key3":"value3"}, nil ``` {% endtab %} {% endtabs %} ### toPrettyJson / mustToPrettyJson The function converts a Go data structure into a pretty-printed JSON string, formatting the output with indentation and line breaks for better readability.

Name	Value
Signature	`ToPrettyJson(v any) string MustToPrettyJson(v any) (string, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ $d := dict "key1" "value1" "key2" "value2" "key3" "value3" }} {{ toPrettyJson $d }} // Output: "{\n \"key1\": \"value1\",\n \"key2\": \"value2\",\n \"key3\": \"value3\"\n}" ``` {% endtab %} {% tab title="Must version" %} ```go {{ $d := dict "key1" "value1" "key2" "value2" "key3" "value3" }} {{ mustToPrettyJson $d }} // Output: "{\n \"key1\": \"value1\",\n \"key2\": \"value2\",\n \"key3\": \"value3\"\n}" ``` {% endtab %} {% endtabs %} ### toRawJson / mustToRawJson The function converts a Go data structure into a JSON string without escaping HTML characters, preserving the raw content as it is.

Name	Value
Signature	`ToRawJson(v any) string MustToRawJson(v any) (string, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ $d := dict "content" "

Hello World

" }} {{ toRawJson $d }} // Output: {"content":"

Hello World

"} ``` {% endtab %} {% tab title="Must version" %} ```go {{ $d := dict "content" "

Hello World

" }} {{ mustToRawJson $d }} // Output: {"content":"

Hello World

"} ``` {% endtab %} {% endtabs %} ### fromYaml / mustFromYaml The function deserializes a YAML string into a Go map, allowing the structured data from YAML to be used and manipulated within a Go program.

Name	Value
Signature	`FromYAML(str string) any MustFromYAML(v string) (any, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ "name: John Doe\nage: 30" | fromYaml }} // Output: map[name:John Doe age:30] ``` {% endtab %} {% tab title="Must version" %} ```go {{ "name: John Doe\nage: 30" | mustFromYAML }} // Output: map[name:John Doe age:30], nil ``` {% endtab %} {% endtabs %} ### toYaml / mustToYaml The function serializes a Go data structure into a YAML string, converting the data into a format suitable for YAML representation.

Name	Value
Signature	`ToYAML(v any) string MustToYAML(v any) (string, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ $d := dict "name" "John Doe" "age" 30 }} {{ toYaml $d }} // Output: name: John Doe\nage: 30 ``` {% endtab %} {% tab title="Must version" %} ```go {{ $d := dict "name" "John Doe" "age" 30 }} {{ $d | mustToYaml }} // Output: name: John Doe\nage: 30 ``` {% endtab %} {% endtabs %}