topic

package

v0.0.0-...-c26a9be Latest Latest Go to latest Published: Oct 16, 2025 License: MIT Imports: 18 Imported by: 0

Details

View Source

const (
	CaravanDebug = "CARAVAN_DEBUG"
)

Environment variables

View Source

const (
	MsgInstantiationTrace = "stack at time of instantiation"
)

Error messages

View Source

var (
	Debug = &debugger{}
)

func Make[Msg any](o ...config.Option) topic.Topic[Msg]

Make instantiates a new internal Topic instance

type Closer struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Closer is an internal implementation of a closer.Closer

func (c *Closer) Close()

Close will instruct the Closer to stop and free its resources

func (c *Closer) IsClosed() <-chan struct{}

IsClosed returns a channel that can participate in a select

type ErrorWrapper func(error) error

ErrorWrapper is a function that wraps an error. It is returned by WrapStackTrace to attach stack information to a standard error

func WrapStackTrace(msg string) ErrorWrapper

WrapStackTrace returns an ErrorWrapper that attaches Stack information to an error based on the call stack when this function is invoked

type Log[Msg any] struct {
	// contains filtered or unexported fields
}

Log manages a set of segments that contain Log entries

type Topic[Msg any] struct {
	*config.Config
	// contains filtered or unexported fields
}

Topic is the internal implementation of a Topic

func (t *Topic[_]) Length() uint64

Length returns the virtual size of the Topic

func (t *Topic[Msg]) NewConsumer() topic.Consumer[Msg]

NewConsumer instantiates a new Topic Consumer

func (t *Topic[Msg]) NewProducer() topic.Producer[Msg]

NewProducer instantiates a new Topic Producer