diff --git a/stdlib/marshal.gr b/stdlib/marshal.gr index ebf20c455..f6f6e115c 100644 --- a/stdlib/marshal.gr +++ b/stdlib/marshal.gr @@ -3,6 +3,10 @@ * * @example from "marshal" include Marshal * + * @example Marshal.marshal(1) + * @example Marshal.marshal("Hello World") + * @example Marshal.unmarshal(b"\x03\x00\x00\x00") + * * @since v0.5.3 */ module Marshal @@ -419,6 +423,9 @@ let marshal = (value, buf) => { * @param value: The value to serialize * @returns A byte-based representation of the value * + * @example Marshal.marshal(1) == b"\x03\x00\x00\x00" + * @example Marshal.marshal("🌾") == Marshal.marshal("🌾") + * * @since v0.5.3 */ @unsafe @@ -1032,6 +1039,9 @@ let unmarshal = buf => { * @param bytes: The data to deserialize * @returns An in-memory value * + * @example Marshal.unmarshal(Marshal.marshal('🌾')) == Ok('🌾') + * @example Marshal.unmarshal(b"\x03\x00\x00\x00") == Ok(1) + * * @since v0.5.3 */ @unsafe diff --git a/stdlib/marshal.md b/stdlib/marshal.md index 23733ff24..679244c1b 100644 --- a/stdlib/marshal.md +++ b/stdlib/marshal.md @@ -13,6 +13,18 @@ No other changes yet. from "marshal" include Marshal ``` +```grain +Marshal.marshal(1) +``` + +```grain +Marshal.marshal("Hello World") +``` + +```grain +Marshal.unmarshal(b"\x03\x00\x00\x00") +``` + ## Values Functions and constants included in the Marshal module. @@ -44,6 +56,16 @@ Returns: |----|-----------| |`Bytes`|A byte-based representation of the value| +Examples: + +```grain +Marshal.marshal(1) == b"\x03\x00\x00\x00" +``` + +```grain +Marshal.marshal("🌾") == Marshal.marshal("🌾") +``` + ### Marshal.**unmarshal**
@@ -74,3 +96,13 @@ Returns: |----|-----------| |`Result`|An in-memory value| +Examples: + +```grain +Marshal.unmarshal(Marshal.marshal('🌾')) == Ok('🌾') +``` + +```grain +Marshal.unmarshal(b"\x03\x00\x00\x00") == Ok(1) +``` +