# 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`

{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World!" | base64Encode }} // Output: "SGVsbG8gV29ybGQh" ``` {% 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, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ "SGVsbG8gV29ybGQh" | 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`

{% 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, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ "JBSWY3DPEBLW64TMMQQQ====" | base32Decode }} // Output: "Hello World!" ``` {% endtab %} {% endtabs %} ### fromJSON 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, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ `{"name":"John", "age":30}` | fromJSON }} // Output: map[age:30 name:John] {{ "{\\invalid" | fromJSON }} // Error ``` {% endtab %} {% endtabs %} ### toJSON 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, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{- $d := dict "key1" "value1" "key2" "value2" "key3" "value3" -}} {{ toJSON $d }} // Output: {\"key1\":\"value1\",\"key2\":\"value2\",\"key3\":\"value3\"} ``` {% endtab %} {% endtabs %} ### toPrettyJSON 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, error)`

{% 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 %} {% endtabs %} ### toRawJSON 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, error)`

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

Hello World

" -}} {{ toRawJSON $d }} // Output: {\"content\":\"

Hello World

\"} ``` {% endtab %} {% endtabs %} ### fromYAML 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(v string) (any, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ "name: John Doe\nage: 30" | fromYAML }} // Output: map[age:30 name:John Doe] ``` {% endtab %} {% endtabs %} ### toYAML 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, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{- $d := dict "name" "John Doe" "age" 30 -}} {{ $d | toYAML }} // Output: age: 30\nname: John Doe ``` {% endtab %} {% endtabs %} ### toIndentYAML The function serializes a Go data structure into a YAML string, converting the data into a format suitable for YAML representation. In addition to toYAML, toIndentYAML takes a parameter to define the indentation width in spaces.

Name	Value
Signature	`ToIndentYAML(indent int, v any) (string, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ $person := dict "name" "John Doe" "age" 30 "location" (dict "country" "US" "planet" "Earth") }} {{ $person | toIndentYAML 2 }} // Output: \nage: 30\nlocation:\n country: US\n planet: Earth\nname: John Doe ``` {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.atom.codes/sprout/registries/encoding.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.