encoding

Documentation

Overview

Package encoding is an internal encoding helper package.

Index

• Constants
• Variables
• func Split(encodedDigest string, n int) (parts []string)
• type Parameter
  • func DecodeParameterStr(input string) (opts []Parameter, err error)
  • func DecodeParameterStrAdvanced(input string, sepItem, sepKV string) (opts []Parameter, err error)
  • func (p Parameter) Int() (int, error)

Constants

const (
	// Delimiter rune for all encodings.
	Delimiter = rune('$')

	// DelimiterStr is the string variation of Delimiter.
	DelimiterStr = string(Delimiter)
)

const (
	// ParameterDefaultItemSeparator is the default item separator.
	ParameterDefaultItemSeparator = ","

	// ParameterDefaultKeyValueSeparator is the default key value separator.
	ParameterDefaultKeyValueSeparator = "="
)

Variables

var (
	// Base64RawAdaptedEncoding is the adapted encoding for crypt purposes without padding.
	Base64RawAdaptedEncoding = base64.NewEncoding(encodeBase64Adapted).WithPadding(base64.NoPadding)
)

Functions

func Split

func Split(encodedDigest string, n int) (parts []string)

Split an encoded digest by the encoding.Delimiter.

Types

type Parameter

type Parameter struct {
	Key   string
	Value string
}

Parameter is a key value pair.

func DecodeParameterStr

func DecodeParameterStr(input string) (opts []Parameter, err error)

DecodeParameterStr is an alias for DecodeParameterStrAdvanced using item separator and key value separator of ',' and '=' respectively.

func DecodeParameterStrAdvanced

func DecodeParameterStrAdvanced(input string, sepItem, sepKV string) (opts []Parameter, err error)

DecodeParameterStrAdvanced decodes parameter strings into a []Parameter where sepItem separates each parameter, and sepKV separates the key and value.

func (Parameter) Int

func (p Parameter) Int() (int, error)

Int converts the Value to an int using strconv.Atoi.