mixer

package module

v0.0.1 Latest Latest Go to latest Published: May 1, 2020 License: MIT Imports: 3 Imported by: 6

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/foolin/mixer

Links

Open Source Insights

README ¶

mixer

Mixer is a very simple encrypt and decrypt golang library for short strings such as id or hash.

Install

go get -u github.com/foolin/mixer

Or get the specified version:

go get github.com/foolin/mixer@{version}

The {version} release list: https://github.com/foolin/mixer/releases

Docs

See Mixer

Usage


package main

import (
	"fmt"
	"github.com/foolin/mixer"
	"log"
)

func main() {

	salt := "a1b2c3d4"

	sources := []string{
		"1234456",
		"12345abcedf",
		"48656c6c6f204d69786572",
	}

	mix := mixer.NewHex(salt)

	for _, source := range sources {

		encodeData := mix.EncodeString(source)
		decodeData := mix.DecodeString(encodeData)
		if source != decodeData {
			log.Fatalf("error: decode data not equal\nsource: %v\nencode: %v\ndecode: %v",
				source, encodeData, decodeData)
		}
		fmt.Printf("-------\nsource: %v\nencode: %v\ndecode: %v\n-------\n", source, encodeData, decodeData)
	}
}

Run output:


-------
source: 1234456
encode: 72e2308
decode: 1234456
-------
-------
source: 12345abcedf
encode: 47e235f9d0c
decode: 12345abcedf
-------
-------
source: 48656c6c6f204d69786572
encode: 7827858a8629541806bb08
decode: 48656c6c6f204d69786572
-------

Documentation ¶

Constants ¶

View Source

const (
	//CharsCaseAlphanumeric the alphanumeric include upper and lower:`0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ`
	CharsCaseAlphanumeric = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"

	//CharsUpperAlphanumeric the alphanumeric include upper:`0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ`
	CharsUpperAlphanumeric = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"

	//CharsLowerAlphanumeric the alphanumeric include lower:`0123456789abcdefghijklmnopqrstuvwxyz`
	CharsLowerAlphanumeric = "0123456789abcdefghijklmnopqrstuvwxyz"

	//CharsUpperAlphabet the upper alphabet:`ABCDEFGHIJKLMNOPQRSTUVWXYZ`
	CharsUpperAlphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"

	//CharsLowerAlphabet the lower alphabet:`abcdefghijklmnopqrstuvwxyz`
	CharsLowerAlphabet = "abcdefghijklmnopqrstuvwxyz"

	//CharsHex the hex alphabet and numeric:`0123456789abcdef`
	CharsHex = "0123456789abcdef"

	//CharsNumeric the numeric:`0123456789abcdef`
	CharsNumeric = "0123456789"
)

View Source

const (
	//AlphanumericCase alphanumericType is CharsCaseAlphanumeric
	AlphanumericCase = iota
	//AlphanumericCase alphanumericType is CharsUpperAlphanumeric
	AlphanumericUpper
	//AlphanumericCase alphanumericType is CharsLowerAlphanumeric
	AlphanumericLower
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Mixer ¶

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

func MustNew ¶

func MustNew(salt string, chars string, moreChars ...string) *Mixer

MustNew must create a new mixer

func New ¶

func New(salt string, chars string, candidateChars ...string) (*Mixer, error)

New create a new mixer

func NewAlphanumeric ¶

func NewAlphanumeric(salt string, alphanumericType int) *Mixer

MustNew must create a new mixer with alphanumeric

func NewHex ¶

func NewHex(salt string) *Mixer

NewHex must create a new mixer with hex

func NewNumeric ¶

func NewNumeric(salt string) *Mixer

NewNumeric must create a new mixer with numeric

func (Mixer) Decode ¶

func (m Mixer) Decode(data []rune) []rune

Decode decode char array

func (Mixer) DecodeString ¶

func (m Mixer) DecodeString(data string) string

DecodeString decode string

func (Mixer) Encode ¶

func (m Mixer) Encode(data []rune) []rune

Encode encode char array

func (Mixer) EncodeString ¶

func (m Mixer) EncodeString(data string) string

Encode encode string

Source Files ¶

View all Source files

mixer.go

Directories ¶

Path	Synopsis
_examples
basic command

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL