marshal

Documentation

Overview

Package defines Spec which is a type to define marshaling behavior.

Index

• type BytesCompatible
• type Spec
  • func Bytes[S BytesCompatible]() Spec[S]
  • func Gob[S any]() Spec[S]

Types

type BytesCompatible

type BytesCompatible interface {
	~string | []byte
}

Type compatible with byte array

type Spec

type Spec[S any] interface {
	// Convert a provided value into a byte array
	Marshal(v S) ([]byte, error)

	// Convert a provided a byte array into a value.
	// This should be an inverse operation of Marshal.
	Unmarshal([]byte) (S, error)
}

Specification of marshaling.

func Bytes

func Bytes[S BytesCompatible]() Spec[S]

Create a bytes spec.

This Spec simply cast a BytesCompatible type into a byte array.

func Gob

func Gob[S any]() Spec[S]

Create a gob spec.

This Spec converts a value into a gob format.