binary.go 1.52 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
package serialize

import (
	"errors"
	"fmt"
	"io"
	"reflect"

	"github.com/ethereum-optimism/optimism/op-service/ioutil"
)

12 13 14 15 16 17
// Deserializable defines functionality for a type that may be deserialized from raw bytes.
type Deserializable interface {
	// Deserialize decodes raw bytes into the type.
	Deserialize(in io.Reader) error
}

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
// Serializable defines functionality for a type that may be serialized to raw bytes.
type Serializable interface {
	// Serialize encodes the type as raw bytes.
	Serialize(out io.Writer) error
}

func LoadSerializedBinary[X any](inputPath string) (*X, error) {
	if inputPath == "" {
		return nil, errors.New("no path specified")
	}
	var f io.ReadCloser
	f, err := ioutil.OpenDecompressed(inputPath)
	if err != nil {
		return nil, fmt.Errorf("failed to open file %q: %w", inputPath, err)
	}
	defer f.Close()

	var x X
36
	serializable, ok := reflect.ValueOf(&x).Interface().(Deserializable)
37 38 39 40 41 42 43 44 45 46
	if !ok {
		return nil, fmt.Errorf("%T is not a Serializable", x)
	}
	err = serializable.Deserialize(f)
	if err != nil {
		return nil, err
	}
	return &x, nil
}

47 48 49 50
func WriteSerializedBinary(value Serializable, target ioutil.OutputTarget) error {
	out, closer, abort, err := target()
	if err != nil {
		return err
51
	}
52 53
	if out == nil {
		return nil // Nothing to write to so skip generating content entirely
54
	}
55 56
	defer abort()
	err = value.Serialize(out)
57 58 59
	if err != nil {
		return fmt.Errorf("failed to write binary: %w", err)
	}
60
	if err := closer.Close(); err != nil {
61 62 63 64
		return fmt.Errorf("failed to finish write: %w", err)
	}
	return nil
}