clog

Documentation

Overview

Package clog provides an interface for sending log messages from yambsd to clients.

Index

• func Log(ctx context.Context, args ...any) error
• func Logf(ctx context.Context, format string, args ...any) error
• func LoggerContext(ctx context.Context, lg Logger) context.Context
• type Logger

Functions

func Log

func Log(ctx context.Context, args ...any) error

Log sends the supplied text, interpreted using fmt.Sprint.

func Logf

func Logf(ctx context.Context, format string, args ...any) error

Logf sends the supplied text, intepreted using fmt.Sprintf.

func LoggerContext

func LoggerContext(ctx context.Context, lg Logger) context.Context

LoggerContext attaches a Logger to a new context derived from ctx. The returned context can later be passed to Log or Logf.

Types

type Logger

type Logger interface {
	// Log writes the supplied message.
	Log(string) error
}

Logger sends informational log messages to a client. This interface exists to prevent circular dependencies: this package can't depend on render, since render depends on seed and sources/text and those packages depend on this package to perform logging.