must

README

go-must

simple go assertion package

By v-braun - viktor-braun.de.

Installation

go get github.com/v-braun/go-must

Usage

// if val == nil will panic with "argument val is nil"
must.ArgNotNil(val, "val") 

// if val <= 1 will panic with val invalid: (0 > 1) == false
must.ArgBeValid(val > 1, "val invalid: (%d > 1) == false", val)

Authors

v-braun

Contributing

Make sure to read these guides before getting started:

• Contribution Guidelines
• Code of Conduct

License

go-must is available under the MIT License. See LICENSE for details.

Documentation

Overview

Package must is a simple assertion package for go

Index

• func ArgBeValid(valid bool, message string, a ...interface{})
• func ArgNotNil(item interface{}, name string)
• func BeFalse(expr bool, message string, a ...interface{})
• func BeTrue(expr bool, message string, a ...interface{})
• func NoError(err error, message string, a ...interface{})

Functions

func ArgBeValid

func ArgBeValid(valid bool, message string, a ...interface{})

ArgBeValid checks the given expression and if it returns true it will panics with the given message and format args

func ArgNotNil

func ArgNotNil(item interface{}, name string)

ArgNotNil panics if item is nil. The error will be 'argument {name} is nil'

func BeFalse

func BeFalse(expr bool, message string, a ...interface{})

func BeTrue

func BeTrue(expr bool, message string, a ...interface{})

func NoError

func NoError(err error, message string, a ...interface{})

NoError panics when error is not nil