protosink

Documentation

Overview

Package protosink provides a cache.Sink using Protobuf encoding

Index

• func NewProtoSink[T any, M ProtoMessage[T]]() cache.TSink[T]
• type ProtoMessage
• type ProtoSink
  • func (sink *ProtoSink[T, M]) Reset()
  • func (sink *ProtoSink[T, M]) SetBytes(b []byte, e time.Time) error
  • func (sink *ProtoSink[T, M]) SetValue(v *T, e time.Time) error
  • func (sink *ProtoSink[T, M]) Value() (*T, bool)

Functions

func NewProtoSink

func NewProtoSink[T any, M ProtoMessage[T]]() cache.TSink[T]

NewProtoSink creates a ProtoSink for a particular proto.Message type

Types

type ProtoMessage

type ProtoMessage[T any] interface {
	proto.Message
	*T
}

ProtoMessage is a generic constraint for a type which pointer implements proto.Message

type ProtoSink

type ProtoSink[T any, M ProtoMessage[T]] struct {
	cache.ByteSink
	// contains filtered or unexported fields
}

ProtoSink is a Sink using Proto for encoding

func (*ProtoSink[T, M]) Reset

func (sink *ProtoSink[T, M]) Reset()

Reset clears everything but the type pointer assigned during creation

func (*ProtoSink[T, M]) SetBytes

func (sink *ProtoSink[T, M]) SetBytes(b []byte, e time.Time) error

SetBytes sets the object of the ProtoSink and its expiration time from a Protobuf encoded byte array

func (*ProtoSink[T, M]) SetValue

func (sink *ProtoSink[T, M]) SetValue(v *T, e time.Time) error

SetValue sets the object of the ProtoSink and its expiration time

func (*ProtoSink[T, M]) Value

func (sink *ProtoSink[T, M]) Value() (*T, bool)

Value returns the stored object