From 0d29f5437a0a4c6fc6ec204074438aa026b5f389 Mon Sep 17 00:00:00 2001 From: dudaodong Date: Mon, 4 Mar 2024 16:41:54 +0800 Subject: [PATCH] doc: update doc for new added functions --- convertor/convertor_test.go | 6 - docs/api/packages/convertor.md | 268 +++++++++++++++--------------- docs/en/api/packages/convertor.md | 268 +++++++++++++++--------------- strutil/string.go | 1 + 4 files changed, 269 insertions(+), 274 deletions(-) diff --git a/convertor/convertor_test.go b/convertor/convertor_test.go index 7587a1f..2380ca4 100644 --- a/convertor/convertor_test.go +++ b/convertor/convertor_test.go @@ -466,12 +466,6 @@ func TestGbkToUtf8(t *testing.T) { assert.Equal("hello", string(utf8Data)) } -func decodeBase64(data []byte) ([]byte, error) { - buf := make([]byte, base64.StdEncoding.DecodedLen(len(data))) - n, err := base64.StdEncoding.Decode(buf, data) - return buf[:n], err -} - func TestToStdBase64(t *testing.T) { t.Parallel() assert := internal.NewAssert(t, "TestToStdBase64") diff --git a/docs/api/packages/convertor.md b/docs/api/packages/convertor.md index 966bf01..841c3b7 100644 --- a/docs/api/packages/convertor.md +++ b/docs/api/packages/convertor.md @@ -903,52 +903,52 @@ import ( func main() { afterEncode := convertor.ToStdBase64(nil) - fmt.Println(afterEncode) + fmt.Println(afterEncode) - afterEncode = convertor.ToStdBase64("") - fmt.Println(afterEncode) + afterEncode = convertor.ToStdBase64("") + fmt.Println(afterEncode) - stringVal := "hello" - afterEncode = convertor.ToStdBase64(stringVal) - fmt.Println(afterEncode) + stringVal := "hello" + afterEncode = convertor.ToStdBase64(stringVal) + fmt.Println(afterEncode) - byteSliceVal := []byte("hello") - afterEncode = convertor.ToStdBase64(byteSliceVal) - fmt.Println(afterEncode) + byteSliceVal := []byte("hello") + afterEncode = convertor.ToStdBase64(byteSliceVal) + fmt.Println(afterEncode) - intVal := 123 - afterEncode = convertor.ToStdBase64(intVal) - fmt.Println(afterEncode) + intVal := 123 + afterEncode = convertor.ToStdBase64(intVal) + fmt.Println(afterEncode) - mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { - A string - B int - }{"hello", 3}} - afterEncode = convertor.ToStdBase64(mapVal) - fmt.Println(afterEncode) + mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { + A string + B int + }{"hello", 3}} + afterEncode = convertor.ToStdBase64(mapVal) + fmt.Println(afterEncode) - floatVal := 123.456 - afterEncode = convertor.ToStdBase64(floatVal) - fmt.Println(afterEncode) + floatVal := 123.456 + afterEncode = convertor.ToStdBase64(floatVal) + fmt.Println(afterEncode) - boolVal := true - afterEncode = convertor.ToStdBase64(boolVal) - fmt.Println(afterEncode) + boolVal := true + afterEncode = convertor.ToStdBase64(boolVal) + fmt.Println(afterEncode) - errVal := errors.New("err") - afterEncode = convertor.ToStdBase64(errVal) - fmt.Println(afterEncode) + errVal := errors.New("err") + afterEncode = convertor.ToStdBase64(errVal) + fmt.Println(afterEncode) - // Output: - // - // - // aGVsbG8= - // aGVsbG8= - // MTIz - // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ== - // MTIzLjQ1Ng== - // dHJ1ZQ== - // ZXJy + // Output: + // + // + // aGVsbG8= + // aGVsbG8= + // MTIz + // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ== + // MTIzLjQ1Ng== + // dHJ1ZQ== + // ZXJy } ``` @@ -975,49 +975,49 @@ import ( func main() { afterEncode := convertor.ToUrlBase64(nil) - fmt.Println(afterEncode) + fmt.Println(afterEncode) - stringVal := "hello" - afterEncode = convertor.ToUrlBase64(stringVal) - fmt.Println(afterEncode) + stringVal := "hello" + afterEncode = convertor.ToUrlBase64(stringVal) + fmt.Println(afterEncode) - byteSliceVal := []byte("hello") - afterEncode = convertor.ToUrlBase64(byteSliceVal) - fmt.Println(afterEncode) + byteSliceVal := []byte("hello") + afterEncode = convertor.ToUrlBase64(byteSliceVal) + fmt.Println(afterEncode) - intVal := 123 - afterEncode = convertor.ToUrlBase64(intVal) - fmt.Println(afterEncode) + intVal := 123 + afterEncode = convertor.ToUrlBase64(intVal) + fmt.Println(afterEncode) - mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { - A string - B int - }{"hello", 3}} - afterEncode = convertor.ToUrlBase64(mapVal) - fmt.Println(afterEncode) + mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { + A string + B int + }{"hello", 3}} + afterEncode = convertor.ToUrlBase64(mapVal) + fmt.Println(afterEncode) - floatVal := 123.456 - afterEncode = convertor.ToUrlBase64(floatVal) - fmt.Println(afterEncode) + floatVal := 123.456 + afterEncode = convertor.ToUrlBase64(floatVal) + fmt.Println(afterEncode) - boolVal := true - afterEncode = convertor.ToUrlBase64(boolVal) - fmt.Println(afterEncode) + boolVal := true + afterEncode = convertor.ToUrlBase64(boolVal) + fmt.Println(afterEncode) - errVal := errors.New("err") - afterEncode = convertor.ToUrlBase64(errVal) - fmt.Println(afterEncode) + errVal := errors.New("err") + afterEncode = convertor.ToUrlBase64(errVal) + fmt.Println(afterEncode) - // Output: + // Output: // - // aGVsbG8= - // aGVsbG8= - // MTIz - // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ== - // MTIzLjQ1Ng== - // dHJ1ZQ== - // ZXJy + // aGVsbG8= + // aGVsbG8= + // MTIz + // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ== + // MTIzLjQ1Ng== + // dHJ1ZQ== + // ZXJy } ``` @@ -1044,45 +1044,45 @@ import ( func main() { - stringVal := "hello" - afterEncode = convertor.ToRawStdBase64(stringVal) - fmt.Println(afterEncode) + stringVal := "hello" + afterEncode = convertor.ToRawStdBase64(stringVal) + fmt.Println(afterEncode) - byteSliceVal := []byte("hello") - afterEncode = convertor.ToRawStdBase64(byteSliceVal) - fmt.Println(afterEncode) + byteSliceVal := []byte("hello") + afterEncode = convertor.ToRawStdBase64(byteSliceVal) + fmt.Println(afterEncode) - intVal := 123 - afterEncode = convertor.ToRawStdBase64(intVal) - fmt.Println(afterEncode) + intVal := 123 + afterEncode = convertor.ToRawStdBase64(intVal) + fmt.Println(afterEncode) - mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { - A string - B int - }{"hello", 3}} - afterEncode = convertor.ToRawStdBase64(mapVal) - fmt.Println(afterEncode) + mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { + A string + B int + }{"hello", 3}} + afterEncode = convertor.ToRawStdBase64(mapVal) + fmt.Println(afterEncode) - floatVal := 123.456 - afterEncode = convertor.ToRawStdBase64(floatVal) - fmt.Println(afterEncode) + floatVal := 123.456 + afterEncode = convertor.ToRawStdBase64(floatVal) + fmt.Println(afterEncode) - boolVal := true - afterEncode = convertor.ToRawStdBase64(boolVal) - fmt.Println(afterEncode) + boolVal := true + afterEncode = convertor.ToRawStdBase64(boolVal) + fmt.Println(afterEncode) - errVal := errors.New("err") - afterEncode = convertor.ToRawStdBase64(errVal) - fmt.Println(afterEncode) + errVal := errors.New("err") + afterEncode = convertor.ToRawStdBase64(errVal) + fmt.Println(afterEncode) - // Output: - // aGVsbG8 - // aGVsbG8 - // MTIz - // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ - // MTIzLjQ1Ng - // dHJ1ZQ - // ZXJy + // Output: + // aGVsbG8 + // aGVsbG8 + // MTIz + // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ + // MTIzLjQ1Ng + // dHJ1ZQ + // ZXJy } ``` @@ -1108,44 +1108,44 @@ import ( func main() { - stringVal := "hello" - afterEncode = convertor.ToRawUrlBase64(stringVal) - fmt.Println(afterEncode) + stringVal := "hello" + afterEncode = convertor.ToRawUrlBase64(stringVal) + fmt.Println(afterEncode) - byteSliceVal := []byte("hello") - afterEncode = convertor.ToRawUrlBase64(byteSliceVal) - fmt.Println(afterEncode) + byteSliceVal := []byte("hello") + afterEncode = convertor.ToRawUrlBase64(byteSliceVal) + fmt.Println(afterEncode) - intVal := 123 - afterEncode = convertor.ToRawUrlBase64(intVal) - fmt.Println(afterEncode) + intVal := 123 + afterEncode = convertor.ToRawUrlBase64(intVal) + fmt.Println(afterEncode) - mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { - A string - B int - }{"hello", 3}} - afterEncode = convertor.ToRawUrlBase64(mapVal) - fmt.Println(afterEncode) + mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { + A string + B int + }{"hello", 3}} + afterEncode = convertor.ToRawUrlBase64(mapVal) + fmt.Println(afterEncode) - floatVal := 123.456 - afterEncode = convertor.ToRawUrlBase64(floatVal) - fmt.Println(afterEncode) + floatVal := 123.456 + afterEncode = convertor.ToRawUrlBase64(floatVal) + fmt.Println(afterEncode) - boolVal := true - afterEncode = convertor.ToRawStdBase64(boolVal) - fmt.Println(afterEncode) + boolVal := true + afterEncode = convertor.ToRawStdBase64(boolVal) + fmt.Println(afterEncode) - errVal := errors.New("err") - afterEncode = convertor.ToRawStdBase64(errVal) - fmt.Println(afterEncode) + errVal := errors.New("err") + afterEncode = convertor.ToRawStdBase64(errVal) + fmt.Println(afterEncode) - // Output: - // aGVsbG8 - // aGVsbG8 - // MTIz - // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ - // MTIzLjQ1Ng - // dHJ1ZQ - // ZXJy + // Output: + // aGVsbG8 + // aGVsbG8 + // MTIz + // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ + // MTIzLjQ1Ng + // dHJ1ZQ + // ZXJy } ``` \ No newline at end of file diff --git a/docs/en/api/packages/convertor.md b/docs/en/api/packages/convertor.md index e437f0e..d61a4f3 100644 --- a/docs/en/api/packages/convertor.md +++ b/docs/en/api/packages/convertor.md @@ -903,52 +903,52 @@ import ( func main() { afterEncode := convertor.ToStdBase64(nil) - fmt.Println(afterEncode) + fmt.Println(afterEncode) - afterEncode = convertor.ToStdBase64("") - fmt.Println(afterEncode) + afterEncode = convertor.ToStdBase64("") + fmt.Println(afterEncode) - stringVal := "hello" - afterEncode = convertor.ToStdBase64(stringVal) - fmt.Println(afterEncode) + stringVal := "hello" + afterEncode = convertor.ToStdBase64(stringVal) + fmt.Println(afterEncode) - byteSliceVal := []byte("hello") - afterEncode = convertor.ToStdBase64(byteSliceVal) - fmt.Println(afterEncode) + byteSliceVal := []byte("hello") + afterEncode = convertor.ToStdBase64(byteSliceVal) + fmt.Println(afterEncode) - intVal := 123 - afterEncode = convertor.ToStdBase64(intVal) - fmt.Println(afterEncode) + intVal := 123 + afterEncode = convertor.ToStdBase64(intVal) + fmt.Println(afterEncode) - mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { - A string - B int - }{"hello", 3}} - afterEncode = convertor.ToStdBase64(mapVal) - fmt.Println(afterEncode) + mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { + A string + B int + }{"hello", 3}} + afterEncode = convertor.ToStdBase64(mapVal) + fmt.Println(afterEncode) - floatVal := 123.456 - afterEncode = convertor.ToStdBase64(floatVal) - fmt.Println(afterEncode) + floatVal := 123.456 + afterEncode = convertor.ToStdBase64(floatVal) + fmt.Println(afterEncode) - boolVal := true - afterEncode = convertor.ToStdBase64(boolVal) - fmt.Println(afterEncode) + boolVal := true + afterEncode = convertor.ToStdBase64(boolVal) + fmt.Println(afterEncode) - errVal := errors.New("err") - afterEncode = convertor.ToStdBase64(errVal) - fmt.Println(afterEncode) + errVal := errors.New("err") + afterEncode = convertor.ToStdBase64(errVal) + fmt.Println(afterEncode) - // Output: - // - // - // aGVsbG8= - // aGVsbG8= - // MTIz - // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ== - // MTIzLjQ1Ng== - // dHJ1ZQ== - // ZXJy + // Output: + // + // + // aGVsbG8= + // aGVsbG8= + // MTIz + // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ== + // MTIzLjQ1Ng== + // dHJ1ZQ== + // ZXJy } ``` @@ -975,49 +975,49 @@ import ( func main() { afterEncode := convertor.ToUrlBase64(nil) - fmt.Println(afterEncode) + fmt.Println(afterEncode) - stringVal := "hello" - afterEncode = convertor.ToUrlBase64(stringVal) - fmt.Println(afterEncode) + stringVal := "hello" + afterEncode = convertor.ToUrlBase64(stringVal) + fmt.Println(afterEncode) - byteSliceVal := []byte("hello") - afterEncode = convertor.ToUrlBase64(byteSliceVal) - fmt.Println(afterEncode) + byteSliceVal := []byte("hello") + afterEncode = convertor.ToUrlBase64(byteSliceVal) + fmt.Println(afterEncode) - intVal := 123 - afterEncode = convertor.ToUrlBase64(intVal) - fmt.Println(afterEncode) + intVal := 123 + afterEncode = convertor.ToUrlBase64(intVal) + fmt.Println(afterEncode) - mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { - A string - B int - }{"hello", 3}} - afterEncode = convertor.ToUrlBase64(mapVal) - fmt.Println(afterEncode) + mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { + A string + B int + }{"hello", 3}} + afterEncode = convertor.ToUrlBase64(mapVal) + fmt.Println(afterEncode) - floatVal := 123.456 - afterEncode = convertor.ToUrlBase64(floatVal) - fmt.Println(afterEncode) + floatVal := 123.456 + afterEncode = convertor.ToUrlBase64(floatVal) + fmt.Println(afterEncode) - boolVal := true - afterEncode = convertor.ToUrlBase64(boolVal) - fmt.Println(afterEncode) + boolVal := true + afterEncode = convertor.ToUrlBase64(boolVal) + fmt.Println(afterEncode) - errVal := errors.New("err") - afterEncode = convertor.ToUrlBase64(errVal) - fmt.Println(afterEncode) + errVal := errors.New("err") + afterEncode = convertor.ToUrlBase64(errVal) + fmt.Println(afterEncode) - // Output: + // Output: // - // aGVsbG8= - // aGVsbG8= - // MTIz - // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ== - // MTIzLjQ1Ng== - // dHJ1ZQ== - // ZXJy + // aGVsbG8= + // aGVsbG8= + // MTIz + // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ== + // MTIzLjQ1Ng== + // dHJ1ZQ== + // ZXJy } ``` @@ -1044,45 +1044,45 @@ import ( func main() { - stringVal := "hello" - afterEncode = convertor.ToRawStdBase64(stringVal) - fmt.Println(afterEncode) + stringVal := "hello" + afterEncode = convertor.ToRawStdBase64(stringVal) + fmt.Println(afterEncode) - byteSliceVal := []byte("hello") - afterEncode = convertor.ToRawStdBase64(byteSliceVal) - fmt.Println(afterEncode) + byteSliceVal := []byte("hello") + afterEncode = convertor.ToRawStdBase64(byteSliceVal) + fmt.Println(afterEncode) - intVal := 123 - afterEncode = convertor.ToRawStdBase64(intVal) - fmt.Println(afterEncode) + intVal := 123 + afterEncode = convertor.ToRawStdBase64(intVal) + fmt.Println(afterEncode) - mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { - A string - B int - }{"hello", 3}} - afterEncode = convertor.ToRawStdBase64(mapVal) - fmt.Println(afterEncode) + mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { + A string + B int + }{"hello", 3}} + afterEncode = convertor.ToRawStdBase64(mapVal) + fmt.Println(afterEncode) - floatVal := 123.456 - afterEncode = convertor.ToRawStdBase64(floatVal) - fmt.Println(afterEncode) + floatVal := 123.456 + afterEncode = convertor.ToRawStdBase64(floatVal) + fmt.Println(afterEncode) - boolVal := true - afterEncode = convertor.ToRawStdBase64(boolVal) - fmt.Println(afterEncode) + boolVal := true + afterEncode = convertor.ToRawStdBase64(boolVal) + fmt.Println(afterEncode) - errVal := errors.New("err") - afterEncode = convertor.ToRawStdBase64(errVal) - fmt.Println(afterEncode) + errVal := errors.New("err") + afterEncode = convertor.ToRawStdBase64(errVal) + fmt.Println(afterEncode) - // Output: - // aGVsbG8 - // aGVsbG8 - // MTIz - // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ - // MTIzLjQ1Ng - // dHJ1ZQ - // ZXJy + // Output: + // aGVsbG8 + // aGVsbG8 + // MTIz + // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ + // MTIzLjQ1Ng + // dHJ1ZQ + // ZXJy } ``` @@ -1108,44 +1108,44 @@ import ( func main() { - stringVal := "hello" - afterEncode = convertor.ToRawUrlBase64(stringVal) - fmt.Println(afterEncode) + stringVal := "hello" + afterEncode = convertor.ToRawUrlBase64(stringVal) + fmt.Println(afterEncode) - byteSliceVal := []byte("hello") - afterEncode = convertor.ToRawUrlBase64(byteSliceVal) - fmt.Println(afterEncode) + byteSliceVal := []byte("hello") + afterEncode = convertor.ToRawUrlBase64(byteSliceVal) + fmt.Println(afterEncode) - intVal := 123 - afterEncode = convertor.ToRawUrlBase64(intVal) - fmt.Println(afterEncode) + intVal := 123 + afterEncode = convertor.ToRawUrlBase64(intVal) + fmt.Println(afterEncode) - mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { - A string - B int - }{"hello", 3}} - afterEncode = convertor.ToRawUrlBase64(mapVal) - fmt.Println(afterEncode) + mapVal := map[string]any{"a": "hi", "b": 2, "c": struct { + A string + B int + }{"hello", 3}} + afterEncode = convertor.ToRawUrlBase64(mapVal) + fmt.Println(afterEncode) - floatVal := 123.456 - afterEncode = convertor.ToRawUrlBase64(floatVal) - fmt.Println(afterEncode) + floatVal := 123.456 + afterEncode = convertor.ToRawUrlBase64(floatVal) + fmt.Println(afterEncode) - boolVal := true - afterEncode = convertor.ToRawStdBase64(boolVal) - fmt.Println(afterEncode) + boolVal := true + afterEncode = convertor.ToRawStdBase64(boolVal) + fmt.Println(afterEncode) - errVal := errors.New("err") - afterEncode = convertor.ToRawStdBase64(errVal) - fmt.Println(afterEncode) + errVal := errors.New("err") + afterEncode = convertor.ToRawStdBase64(errVal) + fmt.Println(afterEncode) - // Output: - // aGVsbG8 - // aGVsbG8 - // MTIz - // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ - // MTIzLjQ1Ng - // dHJ1ZQ - // ZXJy + // Output: + // aGVsbG8 + // aGVsbG8 + // MTIz + // eyJhIjoiaGkiLCJiIjoyLCJjIjp7IkEiOiJoZWxsbyIsIkIiOjN9fQ + // MTIzLjQ1Ng + // dHJ1ZQ + // ZXJy } ``` \ No newline at end of file diff --git a/strutil/string.go b/strutil/string.go index 9aa423f..cda730c 100644 --- a/strutil/string.go +++ b/strutil/string.go @@ -599,6 +599,7 @@ func SubInBetween(str string, start string, end string) string { // HammingDistance calculates the Hamming distance between two strings. // The Hamming distance is the number of positions at which the corresponding symbols are different. // This func returns an error if the input strings are of unequal lengths. +// Play: todo func HammingDistance(a, b string) (int, error) { if len(a) != len(b) { return -1, errors.New("a length and b length are unequal")