padder

Documentation

Index

• Constants
• func Apply(slice []byte, length int, buildEven bool) (padded []byte, padChar rune, err error)
• func Unapply(padded []byte) (slice []byte, padChar rune, err error)

Constants

const (
	// ALTERNATE_PADDING_CHARACTER_1 ...
	ALTERNATE_PADDING_CHARACTER_1 rune = 4 // Unicode U+0004: end-of-transmission

	// ALTERNATE_PADDING_CHARACTER_2 ...
	ALTERNATE_PADDING_CHARACTER_2 rune = 5 // Unicode U+0005: enquiry

	// NO_PADDING_CHARACTER ...
	NO_PADDING_CHARACTER rune = 0 // rune zero value is int32(0)

	// PREPEND_SIZE is the minimum number of prepended padding character in the padded result
	PREPEND_SIZE = 2
)

Functions

func Apply

func Apply(slice []byte, length int, buildEven bool) (padded []byte, padChar rune, err error)

Apply left pads the passed data (generally a slice) making it at least (PREPEND_SIZE + length) bytes long; if the 'buildEven' parameter is set to `true`, it doesn't take PREPEND_SIZE into account and only adds padding bytes to the left up to the passed length.

func Unapply

func Unapply(padded []byte) (slice []byte, padChar rune, err error)

Unapply removes the left padding from the passed padded data.