xgo

README

xgo

Collection of packages to serve as the building blocks for developing Go applications.

Install

$ go get github.com/sudo-suhas/xgo

Usage

Usage for each package is documentated in the respective readme.

• errors (API reference)
• httputil (API reference)

Decision Log

The rationale for important design decisions is documented in decision-log.md.

Credits

A lot of the ideas for the errors package are from these articles and talks:

• "Error handling in Upspin" by Rob Pike and Andrew Gerrand.
• "Failure is your Domain" by Ben Johnson.
• "Handling Go errors" by Marwan Sulaiman from GopherCon 2019.

The JSON decoder implementation in the httputil package is based on "How to Parse a JSON Request Body in Go" by Alex Edwards.

The URL builder in the httputil package drew some inspiration from https://github.com/balazsbotond/urlcat.

Documentation

Overview

Package xgo is a collection of packages to serve as the building blocks for developing Go applications.

Index

• type JSONer
• type Validator
• type ValidatorFunc
  • func (f ValidatorFunc) Validate(v interface{}) error

Types

type JSONer

type JSONer interface {
	JSON() interface{}
}

JSONer is implemented by any value that has a JSON method.

type Validator

type Validator interface {
	// Validate validates the given value.
	Validate(interface{}) error
}

Validator is implemented by any value which has a Validate method.

type ValidatorFunc

type ValidatorFunc func(interface{}) error

ValidatorFunc type is an adapter to allow the use of ordinary functions as a Validator. If f is a function with the appropriate signature, ValidatorFunc(f) is an Validator that calls f.

func (ValidatorFunc) Validate

func (f ValidatorFunc) Validate(v interface{}) error

Validate calls f(v).