triple_hyphen_io

package

v0.0.0-...-791c77c Latest Latest Go to latest Published: May 11, 2025 License: MIT Imports: 10 Imported by: 0

Details

View Source

const (
	Boundary = "---"
)

View Source

var BoundaryStringValue catgut.String

func ReadBoundary(r *catgut.RingBuffer) (n int, err error)

type Coder[O any] struct {
	RequireMetadata bool
	Metadata, Blob  interfaces.Coder[O]
}

func (mr *Coder[O]) DecodeFrom(object O, r io.Reader) (n int64, err error)

func (coder Coder[O]) EncodeTo(
	object O,
	writer io.Writer,
) (n int64, err error)

type CoderTypeMap[S any] map[string]interfaces.Coder[*TypedStruct[S]]

func (c CoderTypeMap[S]) DecodeFrom(
	subject *TypedStruct[S],
	reader io.Reader,
) (n int64, err error)

func (c CoderTypeMap[S]) EncodeTo(
	subject *TypedStruct[S],
	writer io.Writer,
) (n int64, err error)

type CoderTypeMapWithoutType[S any] map[string]interfaces.Coder[S]

func (c CoderTypeMapWithoutType[S]) DecodeFrom(
	subject *TypedStruct[S],
	reader io.Reader,
) (n int64, err error)

func (c CoderTypeMapWithoutType[S]) EncodeTo(
	subject *TypedStruct[S],
	writer io.Writer,
) (n int64, err error)

type Decoder[O any] struct {
	RequireMetadata bool
	Metadata, Blob  interfaces.DecoderFrom[O]
}

func (mr *Decoder[O]) DecodeFrom(object O, r io.Reader) (n int64, err error)

type DecoderTypeMapWithoutType[S any] map[string]interfaces.DecoderFrom[S]

func (c DecoderTypeMapWithoutType[S]) DecodeFrom(
	subject *TypedStruct[S],
	reader io.Reader,
) (n int64, err error)

type MetadataWriterTo interface {
	io.WriterTo
	HasMetadataContent() bool
}

type Reader struct {
	RequireMetadata bool // TODO-P4 add delimiter
	Metadata, Blob  io.ReaderFrom
}

func (mr *Reader) ReadFrom(r io.Reader) (n int64, err error)

type TypedMetadataCoder[O any] struct{}

func (TypedMetadataCoder[O]) DecodeFrom(
	subject *TypedStruct[O],
	reader io.Reader,
) (n int64, err error)

func (TypedMetadataCoder[O]) EncodeTo(
	subject *TypedStruct[O],
	writer io.Writer,
) (n int64, err error)

type TypedStruct[S any] struct {
	Type   *ids.Type
	Struct S
}

func (typedStruct *TypedStruct[S]) GetType() *ids.Type

type Writer struct {
	Metadata, Blob io.WriterTo
}

func (w1 Writer) WriteTo(w2 io.Writer) (n int64, err error)