examples_test.go

package qs

import (
	"fmt"
	"net/url"
	"reflect"
	"sort"
)

func ExampleMarshal() {
	type Query struct {
		Search   string
		Page     int
		PageSize int
	}

	queryString, err := Marshal(&Query{
		Search:   "my search",
		Page:     2,
		PageSize: 50,
	})

	if err != nil {
		fmt.Println(err)
	} else {
		fmt.Println(queryString)
	}
	// Output:
	// page=2&page_size=50&search=my+search
}

func ExampleMarshalValues() {
	type Query struct {
		Search   string
		Page     int
		PageSize int
	}

	// values is a url.Values which is a map[string][]string
	values, err := MarshalValues(&Query{
		Search:   "my search",
		Page:     2,
		PageSize: 50,
	})

	if err != nil {
		fmt.Println(err)
	} else {
		// printing the values map after sorting its keys
		var keys []string
		for key := range values {
			keys = append(keys, key)
		}
		sort.Strings(keys)
		for _, key := range keys {
			fmt.Printf("%v: %v\n", key, values[key])
		}
	}
	// Output:
	// page: [2]
	// page_size: [50]
	// search: [my search]
}

func ExampleCheckMarshal() {
	m := map[string]int{}

	fmt.Println(CheckMarshal(0))
	fmt.Println(CheckMarshal(m))
	fmt.Println(CheckMarshal(&m))
	// Output:
	// unhandled type: int
	// <nil>
	// <nil>
}

func ExampleCheckMarshalType() {
	intType := reflect.TypeOf(0)
	mapType := reflect.TypeOf((map[string]int)(nil))

	fmt.Println(CheckMarshalType(intType))
	fmt.Println(CheckMarshalType(mapType))
	fmt.Println(CheckMarshalType(reflect.PtrTo(mapType)))
	// Output:
	// unhandled type: int
	// <nil>
	// <nil>
}

func ExampleCheckUnmarshal() {
	m := map[string]int{}

	fmt.Println(CheckUnmarshal(0))
	fmt.Println(CheckUnmarshal(m))
	fmt.Println(CheckUnmarshal(&m))
	// Output:
	// expected a pointer, got int
	// expected a pointer, got map[string]int
	// <nil>
}

func ExampleCheckUnmarshalType() {
	intType := reflect.TypeOf(0)
	mapType := reflect.TypeOf((map[string]int)(nil))

	fmt.Println(CheckUnmarshalType(intType))
	fmt.Println(CheckUnmarshalType(mapType))
	fmt.Println(CheckUnmarshalType(reflect.PtrTo(mapType)))
	// Output:
	// expected a pointer, got int
	// expected a pointer, got map[string]int
	// <nil>
}

func ExampleUnmarshal() {
	type Query struct {
		Search   string
		Page     int
		PageSize int
	}

	var q Query
	err := Unmarshal(&q, "page=2&page_size=50&search=my+search")

	if err != nil {
		fmt.Println(err)
	} else {
		fmt.Println(q)
	}
	// Output:
	// {my search 2 50}
}

func ExampleUnmarshalValues() {
	type Query struct {
		Search   string
		Page     int
		PageSize int
	}

	var q Query
	err := UnmarshalValues(&q, url.Values{
		"search":    {"my search"},
		"page":      {"2"},
		"page_size": {"50"},
	})

	if err != nil {
		fmt.Println(err)
	} else {
		fmt.Println(q)
	}
	// Output:
	// {my search 2 50}
}