marshaller

Documentation

Index

• Constants
• func ConfirmMaxSliceSize[T any](t T, maxSize int) error
• func JSONMarshalIndentWithMax[T any](t T, indentSpaces int) ([]byte, error)
• func JSONMarshalWithMax[T any](t T) ([]byte, error)
• func JSONUnmarshalWithMax[T any](b []byte, t *T) error
• func UnmarshalJob(in []byte) (*models.Job, error)
• func YAMLMarshalWithMax[T any](t T) ([]byte, error)
• func YAMLUnmarshalWithMax[T any](b []byte, t *T) error
• type BinaryMarshaller
  • func NewBinaryMarshaller() *BinaryMarshaller
  • func (BinaryMarshaller) Marshal(obj interface{}) ([]byte, error)
  • func (BinaryMarshaller) Unmarshal(data []byte, obj interface{}) error
• type JSONMarshaller
  • func NewJSONMarshaller() *JSONMarshaller
  • func (JSONMarshaller) Marshal(obj interface{}) ([]byte, error)
  • func (JSONMarshaller) Unmarshal(data []byte, obj interface{}) error
• type KeyInt
• type KeyString
• type Marshaller

Constants

const MaxNumberOfObjectsToSerialize = 1000

Arbitrarily choosing 1000 jobs to serialize - this is a pretty high

const MaxSerializedStringInput = int(10 * datasize.MB)

Functions

func ConfirmMaxSliceSize

func ConfirmMaxSliceSize[T any](t T, maxSize int) error

func JSONMarshalIndentWithMax

func JSONMarshalIndentWithMax[T any](t T, indentSpaces int) ([]byte, error)

func JSONMarshalWithMax

func JSONMarshalWithMax[T any](t T) ([]byte, error)

func JSONUnmarshalWithMax

func JSONUnmarshalWithMax[T any](b []byte, t *T) error

func UnmarshalJob

func UnmarshalJob(in []byte) (*models.Job, error)

UnmarshalJob unmarshalled `in` into a models.Job. It returns an error if: - `in` cannot be marshaled to json. - `in` contains an un-settable or unknown field. - `in` cannot be marshaled into a models.Job.

func YAMLMarshalWithMax

func YAMLMarshalWithMax[T any](t T) ([]byte, error)

func YAMLUnmarshalWithMax

func YAMLUnmarshalWithMax[T any](b []byte, t *T) error

Types

type BinaryMarshaller

type BinaryMarshaller struct{}

BinaryMarshaller uses gob encoding for marshaling.

func NewBinaryMarshaller

func NewBinaryMarshaller() *BinaryMarshaller

NewBinaryMarshaller initializes and returns a new BinaryMarshaller.

func (BinaryMarshaller) Marshal

func (BinaryMarshaller) Marshal(obj interface{}) ([]byte, error)

Marshal converts the given object into a gob-encoded byte slice.

func (BinaryMarshaller) Unmarshal

func (BinaryMarshaller) Unmarshal(data []byte, obj interface{}) error

Unmarshal decodes gob data into the given object.

type JSONMarshaller

type JSONMarshaller struct{}

JSONMarshaller uses JSON encoding for marshaling.

func NewJSONMarshaller

func NewJSONMarshaller() *JSONMarshaller

NewJSONMarshaller initializes and returns a new JSONMarshaller.

func (JSONMarshaller) Marshal

func (JSONMarshaller) Marshal(obj interface{}) ([]byte, error)

Marshal converts the given object into a JSON byte slice.

func (JSONMarshaller) Unmarshal

func (JSONMarshaller) Unmarshal(data []byte, obj interface{}) error

Unmarshal decodes JSON data into the given object and normalizes it if applicable.

type KeyInt

type KeyInt int

type KeyString

type KeyString string

type Marshaller

type Marshaller interface {
	// Marshal converts the given object into a byte slice.
	Marshal(interface{}) ([]byte, error)
	// Unmarshal decodes data into the given object, and normalizes it if applicable.
	Unmarshal([]byte, interface{}) error
}

Marshaller defines methods for marshaling and unmarshaling data, and normalizing it if applicable.