util

package

v1.72.0 Latest Latest Go to latest Published: May 13, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aiven/go-api-schemas

Links

Open Source Insights

Documentation ¶

Overview ¶

Package util is the package that contains the utility functions.

Index ¶

Constants
func MeasureExecutionTime(logger *Logger) func()
func Ref[T any](v T) *T
func SetupClient(client *aiven.Client) error
func SetupEnv(env EnvMap) error
func SetupLogger(logger *Logger)
type EnvMap
type Logger

Constants ¶

View Source

const (
	// ServiceTypesFilename is the name of the service types file.
	ServiceTypesFilename = "service_types.yml"

	// IntegrationTypesFilename is the name of the integration types file.
	IntegrationTypesFilename = "integration_types.yml"

	// IntegrationEndpointTypesFilename is the name of the integration endpoint types file.
	IntegrationEndpointTypesFilename = "integration_endpoint_types.yml"
)

View Source

const EnvAivenProjectName = "AIVEN_PROJECT_NAME"

EnvAivenProjectName is the environment variable for the Aiven project name.

Variables ¶

This section is empty.

Functions ¶

func MeasureExecutionTime ¶

func MeasureExecutionTime(logger *Logger) func()

MeasureExecutionTime prints the execution time of the caller when deferred.

func Ref ¶

func Ref[T any](v T) *T

Ref returns the reference (pointer) of the provided value.

func SetupClient ¶

func SetupClient(client *aiven.Client) error

SetupClient sets up the Aiven client.

func SetupEnv ¶

func SetupEnv(env EnvMap) error

SetupEnv populates the provided environment variables map.

func SetupLogger ¶

func SetupLogger(logger *Logger)

SetupLogger sets up the logger.

Types ¶

type EnvMap ¶

type EnvMap map[string]string

EnvMap is a type for a map of environment variables.

type Logger ¶

type Logger struct {
	// Info is the logger for info messages.
	Info *log.Logger

	// Error is the logger for error messages.
	Error *log.Logger
}

Logger is a struct that holds the loggers for the application.

Source Files ¶

View all Source files

util.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL