feat: example code

Author: CC11001100

.idea/.gitignore

@@ -51,23 +51,52 @@ uint32
 uint64
 ```
 
-# string
+# Example Code
 
-# int
-
-# float32
-
-# float64
-
-# bool
+其它类型用法类似：
 
 ```go
 
+// 获取一个布尔指针，其值为true
+boolPointer := pointer.TruePointer()
+fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+fmt.Println(*boolPointer) // output: true
+
+// 获取一个布尔指针，其值为false
+boolPointer = pointer.FalsePointer()
+fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+fmt.Println(*boolPointer) // output: false
+
+// 将布尔变量转换为布尔指针
+boolVar := true
+boolPointer = pointer.ToBoolPointer(boolVar)
+fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+fmt.Println(*boolPointer) // output: true
+boolVar = false
+boolPointer = pointer.ToBoolPointer(boolVar)
+fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+fmt.Println(*boolPointer)                // output: false
+
+// 将布尔变量转换为布尔指针，如果布尔的值为nil的话则返回nil指针
+boolVar = true
+boolPointer = pointer.ToBoolPointerOrNilIfFalse(boolVar)
+fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+fmt.Println(*boolPointer) // output: true
+boolVar = false
+boolPointer = pointer.ToBoolPointerOrNilIfFalse(boolVar)
+fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+fmt.Println(boolPointer) // output: <nil>
+
+// 读取布尔指针变量的值，如果值为nil的话则返回false
+boolVar = pointer.FromBoolPointer(pointer.FalsePointer())
+fmt.Println(boolVar)
+
+// 读取布尔变量的值，如果布尔指针为nil的话则返回给定的默认值，这个默认值可以是true或者false
+boolPointer = nil
+boolVar = pointer.FromBoolPointerOrDefault(boolPointer, true)
+fmt.Println(boolVar) // output: true
 ```
-
-# byte
-
-#  
+     
 
 
 

README.md

@@ -2,19 +2,49 @@ package example
 
 import (
 	"fmt"
-	"go-pointer/pkg/pointer"
+	"github.com/CC11001100/go-pointer/pkg/pointer"
+	"reflect"
 )
 
 func BoolExample() {
 
 	// 获取一个布尔指针，其值为true
 	boolPointer := pointer.TruePointer()
-	fmt.Println(*boolPointer)
+	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+	fmt.Println(*boolPointer)                // output: true
 
 	// 获取一个布尔指针，其值为false
 	boolPointer = pointer.FalsePointer()
-	fmt.Println(*boolPointer)
+	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+	fmt.Println(*boolPointer)                // output: false
 
+	// 将布尔变量转换为布尔指针
+	boolVar := true
+	boolPointer = pointer.ToBoolPointer(boolVar)
+	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+	fmt.Println(*boolPointer)                // output: true
+	boolVar = false
+	boolPointer = pointer.ToBoolPointer(boolVar)
+	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+	fmt.Println(*boolPointer)                // output: false
 
+	// 将布尔变量转换为布尔指针，如果布尔的值为nil的话则返回nil指针
+	boolVar = true
+	boolPointer = pointer.ToBoolPointerOrNilIfFalse(boolVar)
+	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+	fmt.Println(*boolPointer)                // output: true
+	boolVar = false
+	boolPointer = pointer.ToBoolPointerOrNilIfFalse(boolVar)
+	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+	fmt.Println(boolPointer)                 // output: <nil>
+
+	// 读取布尔指针变量的值，如果值为nil的话则返回false
+	boolVar = pointer.FromBoolPointer(pointer.FalsePointer())
+	fmt.Println(boolVar)
+
+	// 读取布尔变量的值，如果布尔指针为nil的话则返回给定的默认值，这个默认值可以是true或者false
+	boolPointer = nil
+	boolVar = pointer.FromBoolPointerOrDefault(boolPointer, true)
+	fmt.Println(boolVar) // output: true
 
 }

example/bool_example.go

@@ -0,0 +1,35 @@
+package example
+
+//func ByteExample() {
+//
+//	// 获取一个布尔指针，其值为true
+//	boolPointer := pointer.Byte()
+//	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+//	fmt.Println(*boolPointer)                // output: true
+//
+//	// 获取一个布尔指针，其值为false
+//	boolPointer = pointer.FalsePointer()
+//	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+//	fmt.Println(*boolPointer)                // output: false
+//
+//	// 将布尔变量转换为布尔指针
+//	boolVar := true
+//	boolPointer = pointer.ToBoolPointer(boolVar)
+//	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+//	fmt.Println(*boolPointer)                // output: true
+//	boolVar = false
+//	boolPointer = pointer.ToBoolPointer(boolVar)
+//	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+//	fmt.Println(*boolPointer)                // output: false
+//
+//	// 将布尔变量转换为布尔指针，如果布尔的值为nil的话则返回nil指针
+//	boolVar = true
+//	boolPointer = pointer.ToBoolPointerOrNilIfFalse(boolVar)
+//	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+//	fmt.Println(*boolPointer)                // output: true
+//	boolVar = false
+//	boolPointer = pointer.ToBoolPointerOrNilIfFalse(boolVar)
+//	fmt.Println(reflect.TypeOf(boolPointer)) // output: *bool
+//	fmt.Println(boolPointer)                 // output: <nil>
+//
+//}

example/byte_example.go

@@ -0,0 +1 @@
+package example

example/complex128_example.go

@@ -0,0 +1 @@
+package example

example/complex64_example.go

@@ -4,6 +4,6 @@ import "testing"
 
 func Test(t *testing.T) {
 
-	BoolExample()
-	
+	TimeTimeExample()
+
 }

example/example_test.go

@@ -0,0 +1 @@
+package example

example/float32_example.go

@@ -0,0 +1 @@
+package example

example/float64_example.go

@@ -0,0 +1,40 @@
+package example
+
+import (
+	"fmt"
+	"github.com/CC11001100/go-pointer/pkg/pointer"
+	"reflect"
+)
+
+// Int16Example int16与*int16类型互相转换的示例代码
+func Int16Example() {
+
+	var int16Var int16
+	var int16Pointer *int16
+
+	// 将int16变量转为*int16类型的指针
+	int16Var = 10086
+	int16Pointer = pointer.ToInt16Pointer(int16Var)
+	fmt.Println(reflect.TypeOf(int16Pointer)) // output: *int16
+	fmt.Println(*int16Pointer)                // output: 10086
+
+	// 可以在int16转换为*int16的时候把0值转为nil指针
+	int16Var = 0
+	int16Pointer = pointer.ToInt16PointerOrNilIfZero(int16Var)
+	fmt.Println(int16Pointer) // output: <nil>
+
+	// 读取*int16指针所指向的地址的值
+	int16Pointer = pointer.ToInt16Pointer(10010)
+	int16Var = pointer.FromInt16Pointer(int16Pointer)
+	fmt.Println(int16Var) // output: 10010
+
+	// 如果*int16为nil，则返回0
+	int16Pointer = nil
+	int16Var = pointer.FromInt16Pointer(int16Pointer)
+	fmt.Println(int16Var) // output: 0
+
+	// 可以自定义为nil的时候的默认值
+	int16Var = pointer.FromInt16PointerOrDefaultIfNil(int16Pointer, 100)
+	fmt.Println(int16Var) // output: 100
+
+}