gobutil

README

gobutil

golang gob utils for common use

Basic Usage

Installation

To get the package, execute:

go get github.com/gofika/gobutil

Example

package main

import (
	"fmt"

	"github.com/gofika/gobutil"
)

func main() {
	type Foo struct {
		Name  string
		Value int
	}
	type Bar struct {
		Name  string
		Value int
	}
	foo := &Foo{"Jason", 100}
	// deep copy for different struct
	bar, err := gobutil.DeepCopy[Bar](foo)
	if err != nil {
		fmt.Printf("DeepCopy failed. err: %s\n", err.Error())
		return
	}
	fmt.Printf("bar.Name: %s\n", bar.Name)
	fmt.Printf("bar.Value: %d\n", bar.Value)
}

Documentation

Index

• func DeepCopy[T any](src any) (T, error)
• func DeepCopyAny(dst, src any) error
• func ReadBytes[T any](b []byte) (T, error)
• func ReadBytesAny(b []byte, v any) error
• func ReadFile[T any](filename string) (T, error)
• func ReadFileAny(filename string, v any) error
• func ReadReader[T any](r io.Reader) (T, error)
• func ReadReaderAny(r io.Reader, v any) error
• func WriteBytes(v any) ([]byte, error)
• func WriteFile(filename string, v any) error
• func WriteWriter(w io.Writer, v any) error

Functions

func DeepCopy

func DeepCopy[T any](src any) (T, error)

DeepCopy clone object. can clone without same type

Example:

type Foo struct {
    Name string
    Value int
}

type Bar struct {
    Name string
    Value int
}

foo := &Foo { "Jason", 100}
bar, err := DeepCopy[Bar](foo)
fmt.Printf("%+v\n", bar)

func DeepCopyAny

func DeepCopyAny(dst, src any) error

DeepCopyAny clone object to dst. can clone without same type

func ReadBytes

func ReadBytes[T any](b []byte) (T, error)

ReadBytes read typed struct from bytes

func ReadBytesAny

func ReadBytesAny(b []byte, v any) error

ReadBytesAny read struct from bytes

func ReadFile

func ReadFile[T any](filename string) (T, error)

ReadFile read struct from gob stream file

func ReadFileAny

func ReadFileAny(filename string, v any) error

ReadFileAny read struct from gob stream file

func ReadReader

func ReadReader[T any](r io.Reader) (T, error)

ReadReader read struct from reader

func ReadReaderAny

func ReadReaderAny(r io.Reader, v any) error

ReadReaderAny read struct from reader

func WriteBytes

func WriteBytes(v any) ([]byte, error)

WriteBytes write struct to gob stream bytes

func WriteFile

func WriteFile(filename string, v any) error

WriteFile write struct to gob stream file

func WriteWriter

func WriteWriter(w io.Writer, v any) error

WriteWriter write struct to gob stream writer