testing

Documentation

Overview

Package whoopsie/identifier/testing implements a couple of Ids that are useful for testing things that use whoopsie/identifier.

Index

• type FailingIdentifier
  • func Failing() *FailingIdentifier
  • func (*FailingIdentifier) Generate() error
  • func (*FailingIdentifier) String() string
• type SettableIdentifier
  • func Settable() *SettableIdentifier
  • func (sid *SettableIdentifier) Generate() error
  • func (sid *SettableIdentifier) Set(value string)
  • func (sid *SettableIdentifier) String() string

Types

type FailingIdentifier

type FailingIdentifier struct{}

FailingIdentifier is an Id that always fails to generate.

func Failing

func Failing() *FailingIdentifier

Failing is the constructor for FailingIdentifier.

func (*FailingIdentifier) Generate

func (*FailingIdentifier) Generate() error

Generate fails with an ubiquitous error.

func (*FailingIdentifier) String

func (*FailingIdentifier) String() string

String returns "<Failing>".

The purpose of this is to make it easy to spot if you're using it by accident.

type SettableIdentifier

type SettableIdentifier struct {
	// contains filtered or unexported fields
}

SettableIdentifier is an Id that lets you set the value of the identifier.

By default the identifier's value is "<Settable>", so it's visible if you're misusing it.

func Settable

func Settable() *SettableIdentifier

Settable is the constructor for SettableIdentifier.

func (*SettableIdentifier) Generate

func (sid *SettableIdentifier) Generate() error

Generate does nothing.

func (*SettableIdentifier) Set

func (sid *SettableIdentifier) Set(value string)

Set is the method you use to set the identifier.

func (*SettableIdentifier) String

func (sid *SettableIdentifier) String() string

String returns the string you set.