mdbson

Documentation

Overview

Package mdbson supports serialization and deserialization using BSON. Objects with interface fields are serialized and deserialized using madkins23/go-type/reg. This package is patterned after JSON and YAML code in madkins23/go-serial.

Index

• type Pointer
  • func Point[T pointer.Target](target T) *Pointer[T]
  • func (p *Pointer[T]) Get() T
  • func (p *Pointer[T]) MarshalBSON() ([]byte, error)
  • func (p *Pointer[T]) Set(t T)
  • func (p *Pointer[T]) UnmarshalBSON(marshaled []byte) error
• type Wrapper
  • func Wrap[W any](item W) *Wrapper[W]
  • func (w *Wrapper[T]) Get() T
  • func (w *Wrapper[T]) MarshalBSON() ([]byte, error)
  • func (w *Wrapper[T]) Set(t T)
  • func (w *Wrapper[T]) UnmarshalBSON(marshaled []byte) error

Types

type Pointer

type Pointer[T pointer.Target] struct {
	// contains filtered or unexported fields
}

Pointer is used to specify an object that may be found in a cache or DB.

func Point

func Point[T pointer.Target](target T) *Pointer[T]

func (*Pointer[T]) Get

func (p *Pointer[T]) Get() T

Get the Target item from the Pointer.

func (*Pointer[T]) MarshalBSON

func (p *Pointer[T]) MarshalBSON() ([]byte, error)

func (*Pointer[T]) Set

func (p *Pointer[T]) Set(t T)

Set the Target item for the Pointer.

func (*Pointer[T]) UnmarshalBSON

func (p *Pointer[T]) UnmarshalBSON(marshaled []byte) error

type Wrapper

type Wrapper[T any] struct {
	// contains filtered or unexported fields
}

Wrapper is used to attach a type name to an item to be serialized. This supports re-creating the correct type for filling an interface field.

func Wrap

func Wrap[W any](item W) *Wrapper[W]

Wrap an item in a BSON wrapper that can handle serialization.

func (*Wrapper[T]) Get

func (w *Wrapper[T]) Get() T

Get the wrapped item.

func (*Wrapper[T]) MarshalBSON

func (w *Wrapper[T]) MarshalBSON() ([]byte, error)

func (*Wrapper[T]) Set

func (w *Wrapper[T]) Set(t T)

Set the wrapped item.

func (*Wrapper[T]) UnmarshalBSON

func (w *Wrapper[T]) UnmarshalBSON(marshaled []byte) error