anogo

README

AnoGo

AnoGo is an util package for Go, used by most A-Novel repositories.

go get github.com/a-novel/anogo

• Map functions
  • ToMap functions
• Pointer functions
  • IsPtr
  • IsSlicePtr

Map functions

The following functions refer to map-like go types and their usage.

ToMap functions

Perform conversions between map-like values.

Function	Arguments
ToMap()	v interface{} ptr pointer
ToMapInterface()	v interface{}
ToMapString()	v interface{}

Each function may return any of the following errors:

• anogo.ErrIsNotPtr
• anogo.ErrIsNestedPtr
• anogo.ErrIsNotMappable
• anogo.ErrCannotMarshal
• anogo.ErrCannotUnmarshal

Flatten

Flatten a map-like object.

flattened, err := anogo.Flatten(data)

Data should be either of type struct or map.

It may return any of the following errors:

• anogo.ErrCannotMarshal
• anogo.ErrCannotUnmarshal

Pointer functions

The following functions refer to pointers and their usage.

IsPtr

This function will return an error if the value passed as an argument doesn't represent a direct pointer to a defined value. Nested pointers are also refused.

err := anogo.IsPtr(value)

It may return any of the following errors:

• anogo.ErrIsNotPtr
• anogo.ErrIsNestedPtr

IsSlicePtr

This function will return an error if the value passed as an argument doesn't represent a slice of pointers. Nested pointers are also refused for slice type.

err := anogo.IsPtr(value)

It may return any of the following errors:

• anogo.ErrIsNotPtr
• anogo.ErrIsNestedPtr
• anogo.ErrIsNotSlice

License

2021, A-Novel MIT License.

Documentation

Index

• Constants
• func Delete(url string, payload interface{}, headers Header) (int, []byte, *errors.Error)
• func Flatten(data interface{}) (map[string]interface{}, *errors.Error)
• func Get(url string, headers Header) (int, []byte, *errors.Error)
• func GetExecPath() (string, *errors.Error)
• func IsPtr(ptr interface{}) *errors.Error
• func IsSlicePtr(ptr interface{}) *errors.Error
• func Post(url string, payload interface{}, headers Header) (int, []byte, *errors.Error)
• func Put(url string, payload interface{}, headers Header) (int, []byte, *errors.Error)
• func ReadConfig(cpath string, ptr interface{}) *errors.Error
• func Request(method, url string, payload interface{}, headers Header) (int, []byte, *errors.Error)
• func SliceEqual(a, b interface{}) bool
• func StartGinTestServer(routers []func(*gin.Engine)) (*httptest.Server, func(p string) string)
• func TestPostJSON(url string, body interface{}, expectedStatus int, ...) *errors.Error
• func ToMap(v interface{}, ptr interface{}) *errors.Error
• func ToMapInterface(v interface{}) (map[string]interface{}, *errors.Error)
• func ToMapString(v interface{}) (map[string]string, *errors.Error)
• type Header
  • func (h Header) JSON()
  • func (h Header) Token(token string)
  • func (h Header) UserAgent(ua string)
• type ToMapOptions

Constants

const (
	ErrIsNotPtr                 = "err_is_not_ptr"
	ErrIsNestedPtr              = "err_is_nested_ptr"
	ErrIsNotSlice               = "err_is_not_slice"
	ErrIsNotMappable            = "err_is_not_mappable"
	ErrCannotMarshal            = "err_cannot_marshal"
	ErrCannotUnmarshal          = "err_cannot_unmarshal"
	ErrCannotReadFilePath       = "err_cannot_read_path_file"
	ErrCannotOpenConfigFile     = "err_cannot_open_config_file"
	ErrCannotParseConfigFile    = "err_cannot_parse_config_file"
	ErrCannotCreateRequest      = "err_cannot_create_post_request"
	ErrRequestFailed            = "err_request_failed"
	ErrCannotParseRequestBody   = "err_cannot_parse_request_body"
	ErrUnexpectedResponseStatus = "err_unexpected_response_status"
	ErrUnexpectedResponse       = "err_unexpected_response"
)

Functions

func Delete

func Delete(url string, payload interface{}, headers Header) (int, []byte, *errors.Error)

func Flatten

func Flatten(data interface{}) (map[string]interface{}, *errors.Error)

Flattens a map-like object.

May return:

• ErrIsNotPtr
• ErrIsNestedPtr
• ErrIsNotMappable
• ErrCannotMarshal
• ErrCannotUnmarshal

func Get

func Get(url string, headers Header) (int, []byte, *errors.Error)

func GetExecPath

func GetExecPath() (string, *errors.Error)

Return go executable path.

May return:

• ErrCannotReadFilePath

func IsPtr

func IsPtr(ptr interface{}) *errors.Error

Check if value is a pointer.

May return:

• ErrIsNotPtr
• ErrIsNestedPtr

func IsSlicePtr

func IsSlicePtr(ptr interface{}) *errors.Error

Check if slice is a slice of pointers.

May return:

• ErrIsNotSlice
• ErrIsNotPtr
• ErrIsNestedPtr

func Post

func Post(url string, payload interface{}, headers Header) (int, []byte, *errors.Error)

func Put

func Put(url string, payload interface{}, headers Header) (int, []byte, *errors.Error)

func ReadConfig

func ReadConfig(cpath string, ptr interface{}) *errors.Error

Reads a config file and assign it to a pointer.

May return:

• ErrCannotOpenConfigFile
• ErrCannotParseConfigFile

func Request

func Request(method, url string, payload interface{}, headers Header) (int, []byte, *errors.Error)

func SliceEqual

func SliceEqual(a, b interface{}) bool

Check if 2 slice value are equal. Return false if any value is not of type Slice.

func StartGinTestServer

func StartGinTestServer(routers []func(*gin.Engine)) (*httptest.Server, func(p string) string)

func TestPostJSON

func TestPostJSON(url string, body interface{}, expectedStatus int, expectedResponse map[string]interface{}) *errors.Error

func ToMap

func ToMap(v interface{}, ptr interface{}) *errors.Error

Convert v to the underlying value of ptr.

May return:

• ErrIsNotPtr
• ErrIsNestedPtr
• ErrIsNotMappable
• ErrCannotMarshal
• ErrCannotUnmarshal

func ToMapInterface

func ToMapInterface(v interface{}) (map[string]interface{}, *errors.Error)

Convert v to a map[string]interface{}.

May return:

• ErrIsNotPtr
• ErrIsNestedPtr
• ErrIsNotMappable
• ErrCannotMarshal
• ErrCannotUnmarshal

func ToMapString

func ToMapString(v interface{}) (map[string]string, *errors.Error)

Convert v to a map[string]string.

May return:

• ErrIsNotPtr
• ErrIsNestedPtr
• ErrIsNotMappable
• ErrCannotMarshal
• ErrCannotUnmarshal

Types

type Header

type Header map[string]string

func (Header) JSON

func (h Header) JSON()

func (Header) Token

func (h Header) Token(token string)

func (Header) UserAgent

func (h Header) UserAgent(ua string)

type ToMapOptions

type ToMapOptions struct {
	PreservePointers bool
	PreserveStructs  bool
}