commonfmt

README

Common Formatting

This packages contains functions to format some general messages and values.

Documentation

Index

• Variables
• func FmtByteCount(count int64, _3digitGroupCount int) (string, error)
• func FmtErrArgumentProvidedAtLeastTwice(name string) error
• func FmtErrInvalidArgumentAtPos(pos int, explanation string) error
• func FmtErrInvalidOptionName(name string) error
• func FmtErrNArgumentsExpected(count string) error
• func FmtErrOptionProvidedAtLeastTwice(name string) error
• func FmtErrWhileCallingMigrationHandler(pth []string, err error) error
• func FmtErrWhileCloningValueFor(pth []string, err error) error
• func FmtErrXProvidedAtLeastTwice(name string) error
• func FmtFailedToSetPropXAcceptXButZProvided(name string, accepted string, provided string) error
• func FmtInoxDate(d time.Time) string
• func FmtInoxDateTime(d time.Time) string
• func FmtInoxDuration(d time.Duration) string
• func FmtInoxYear(d time.Time) string
• func FmtInvalidLastSegmentOfMigrationPathShouldbeAnInteger(pth []string) error
• func FmtInvalidValueForPropXOfArgY(propName string, argName string, msg string) error
• func FmtLastSegmentOfMigrationPathIsOutOfBounds(pth []string) error
• func FmtMissingArgument(argName string) error
• func FmtMissingNextPattern(pth []string) error
• func FmtMissingPropInArgX(propName string, argName string) error
• func FmtNotSharableBecausePropertyNotSharable(propName, explanation string) string
• func FmtPropOfArgXShouldBeY(propName string, argName string, info string) error
• func FmtRune(r rune) string
• func FmtUnexpectedElementAtIndexOfArgShowVal(keyIndex int, argName string, s string) error
• func FmtUnexpectedElementInPropIterable(propertyName string, s string) error
• func FmtUnexpectedElementInPropIterableOfArgX(propertyName string, argName string, s string) error
• func FmtUnexpectedPropInArgX(propName string, argName string) error
• func FmtValueAtPathDoesNotExist(pth string) error
• func FmtValueAtPathSegmentsDoesNotExist(pth []string) error
• func FmtValueAtPathSegmentsIsNotMigrationCapable(pth []string) error
• func FormatGoFunctionSignature(f any) string

Variables

var (
	QUOTED_BELL_RUNE   = []byte("'\\b'")
	QUOTED_FFEED_RUNE  = []byte("'\\f'")
	QUOTED_NL_RUNE     = []byte("'\\n'")
	QUOTED_CR_RUNE     = []byte("'\\r'")
	QUOTED_TAB_RUNE    = []byte("'\\t'")
	QUOTED_VTAB_RUNE   = []byte("'\\v'")
	QUOTED_SQUOTE_RUNE = []byte("'\\''")
	QUOTED_ASLASH_RUNE = []byte("'\\\\'")
)

Functions

func FmtByteCount

func FmtByteCount(count int64, _3digitGroupCount int) (string, error)

func FmtErrArgumentProvidedAtLeastTwice

func FmtErrArgumentProvidedAtLeastTwice(name string) error

func FmtErrInvalidArgumentAtPos

func FmtErrInvalidArgumentAtPos(pos int, explanation string) error

func FmtErrInvalidOptionName

func FmtErrInvalidOptionName(name string) error

func FmtErrNArgumentsExpected

func FmtErrNArgumentsExpected(count string) error

func FmtErrOptionProvidedAtLeastTwice

func FmtErrOptionProvidedAtLeastTwice(name string) error

func FmtErrWhileCallingMigrationHandler

func FmtErrWhileCallingMigrationHandler(pth []string, err error) error

func FmtErrWhileCloningValueFor

func FmtErrWhileCloningValueFor(pth []string, err error) error

func FmtErrXProvidedAtLeastTwice

func FmtErrXProvidedAtLeastTwice(name string) error

func FmtFailedToSetPropXAcceptXButZProvided

func FmtFailedToSetPropXAcceptXButZProvided(name string, accepted string, provided string) error

func FmtInoxDate

func FmtInoxDate(d time.Time) string

func FmtInoxDateTime

func FmtInoxDateTime(d time.Time) string

func FmtInoxDuration

func FmtInoxDuration(d time.Duration) string

func FmtInoxYear

func FmtInoxYear(d time.Time) string

func FmtInvalidLastSegmentOfMigrationPathShouldbeAnInteger

func FmtInvalidLastSegmentOfMigrationPathShouldbeAnInteger(pth []string) error

func FmtInvalidValueForPropXOfArgY

func FmtInvalidValueForPropXOfArgY(propName string, argName string, msg string) error

func FmtLastSegmentOfMigrationPathIsOutOfBounds

func FmtLastSegmentOfMigrationPathIsOutOfBounds(pth []string) error

func FmtMissingArgument

func FmtMissingArgument(argName string) error

func FmtMissingNextPattern

func FmtMissingNextPattern(pth []string) error

func FmtMissingPropInArgX

func FmtMissingPropInArgX(propName string, argName string) error

func FmtNotSharableBecausePropertyNotSharable

func FmtNotSharableBecausePropertyNotSharable(propName, explanation string) string

func FmtPropOfArgXShouldBeY

func FmtPropOfArgXShouldBeY(propName string, argName string, info string) error

func FmtRune

func FmtRune(r rune) string

func FmtUnexpectedElementAtIndexOfArgShowVal

func FmtUnexpectedElementAtIndexOfArgShowVal(keyIndex int, argName string, s string) error

func FmtUnexpectedElementInPropIterable

func FmtUnexpectedElementInPropIterable(propertyName string, s string) error

func FmtUnexpectedElementInPropIterableOfArgX

func FmtUnexpectedElementInPropIterableOfArgX(propertyName string, argName string, s string) error

func FmtUnexpectedPropInArgX

func FmtUnexpectedPropInArgX(propName string, argName string) error

func FmtValueAtPathDoesNotExist

func FmtValueAtPathDoesNotExist(pth string) error

func FmtValueAtPathSegmentsDoesNotExist

func FmtValueAtPathSegmentsDoesNotExist(pth []string) error

func FmtValueAtPathSegmentsIsNotMigrationCapable

func FmtValueAtPathSegmentsIsNotMigrationCapable(pth []string) error

func FormatGoFunctionSignature

func FormatGoFunctionSignature(f any) string