options.go

package mltmorse

// IgnoreHandler ignores the error and returns nothing
func IgnoreHandler(error) string { return "" }

// PanicHandler is a handler that panics when an error occurs
func PanicHandler(err error) string { panic(err) }

// ConverterOption is a function that modifies a Converter
// The main use of ConvertOption is inside NewConverter
type ConverterOption func(Converter) Converter

// WithHandler sets the handler for the Converter
func WithHandler(handler ErrorHandler) ConverterOption {
	return func(c Converter) Converter {
		c.Handling = handler
		return c
	}
}

// WithLowercaseHandling sets if the Converter may convert to uppercase before checking inside the EncodingMap
func WithLowercaseHandling(lowercaseHandling bool) ConverterOption {
	return func(c Converter) Converter {
		c.convertToUpper = lowercaseHandling
		return c
	}
}

// WithTrailingSeparator sets if the Converter may trail the charSeparator
func WithTrailingSeparator(trailingSpace bool) ConverterOption {
	return func(c Converter) Converter {
		c.trailingSeparator = trailingSpace
		return c
	}
}

// WithCharSeparator sets the Character Separator
// The CharSeparator is the character used to separate two characters inside a Word
func WithCharSeparator(charSeparator string) ConverterOption {
	return func(c Converter) Converter {
		c.charSeparator = charSeparator
		return c
	}
}

// WithWordSeparator sets the Word Separator
// The Word Separator is used to separate two words, usually this is the Character Separator, a Space and another Character Separator
func WithWordSeparator(wordSeparator string) ConverterOption {
	return func(c Converter) Converter {
		c.wordSeparator = wordSeparator
		return c
	}
}

// WithStrNormalizer sets the string normalizer function
// The Word Separator is used to normalize string
func WithStrNormalizer(normalizer StrNormalizer) ConverterOption {
	return func(c Converter) Converter {
		c.Normalizer = normalizer
		return c
	}
}