objx

package

v0.2.0 Latest Latest Go to latest Published: Apr 6, 2015 License: MIT, Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/deis/swarm

Links

Open Source Insights

README ¶

objx

Jump into the API Documentation

Documentation ¶

Overview ¶

objx - Go package for dealing with maps, slices, JSON and other data.

Overview ¶

Objx provides the `objx.Map` type, which is a `map[string]interface{}` that exposes a powerful `Get` method (among others) that allows you to easily and quickly get access to data within the map, without having to worry too much about type assertions, missing data, default values etc.

Pattern ¶

Objx uses a preditable pattern to make access data from within `map[string]interface{}'s easy.

Call one of the `objx.` functions to create your `objx.Map` to get going:

m, err := objx.FromJSON(json)

NOTE: Any methods or functions with the `Must` prefix will panic if something goes wrong, the rest will be optimistic and try to figure things out without panicking.

Use `Get` to access the value you're interested in. You can use dot and array notation too:

m.Get("places[0].latlng")

Once you have saught the `Value` you're interested in, you can use the `Is*` methods to determine its type.

if m.Get("code").IsStr() { /* ... */ }

Or you can just assume the type, and use one of the strong type methods to extract the real value:

m.Get("code").Int()

If there's no value there (or if it's the wrong type) then a default value will be returned, or you can be explicit about the default value.

Get("code").Int(-1)

If you're dealing with a slice of data as a value, Objx provides many useful methods for iterating, manipulating and selecting that data. You can find out more by exploring the index below.

Reading data ¶

A simple example of how to use Objx:

// use MustFromJSON to make an objx.Map from some JSON
m := objx.MustFromJSON(`{"name": "Mat", "age": 30}`)

// get the details
name := m.Get("name").Str()
age := m.Get("age").Int()

// get their nickname (or use their name if they
// don't have one)
nickname := m.Get("nickname").Str(name)

Ranging ¶

Since `objx.Map` is a `map[string]interface{}` you can treat it as such. For example, to `range` the data, do what you would expect:

m := objx.MustFromJSON(json)
for key, value := range m {

  /* ... do your magic ... */

}

Index ¶

Constants
func HashWithKey(data, key string) string
type MSIConvertable
type Map
type Value

Constants ¶

View Source

const (
	// PathSeparator is the character used to separate the elements
	// of the keypath.
	//
	// For example, `location.address.city`
	PathSeparator string = "."

	// SignatureSeparator is the character that is used to
	// separate the Base64 string from the security signature.
	SignatureSeparator = "_"
)

Variables ¶

This section is empty.

Functions ¶

func HashWithKey ¶

func HashWithKey(data, key string) string

HashWithKey hashes the specified string using the security key.

Types ¶

type MSIConvertable ¶

type MSIConvertable interface {
	// MSI gets a map[string]interface{} (msi) representing the
	// object.
	MSI() map[string]interface{}
}

MSIConvertable is an interface that defines methods for converting your custom types to a map[string]interface{} representation.

type Map ¶

type Map map[string]interface{}

Map provides extended functionality for working with untyped data, in particular map[string]interface (msi).

var Nil Map = New(nil)

Nil represents a nil Map.

func FromBase64 ¶

func FromBase64(base64String string) (Map, error)

FromBase64 creates a new Obj containing the data specified in the Base64 string.

The string is an encoded JSON string returned by Base64

func FromJSON ¶

func FromJSON(jsonString string) (Map, error)

FromJSON creates a new Map containing the data specified in the jsonString.

Returns an error if the JSON is invalid.

func FromSignedBase64 ¶

func FromSignedBase64(base64String, key string) (Map, error)

FromSignedBase64 creates a new Obj containing the data specified in the Base64 string.

The string is an encoded JSON string returned by SignedBase64

func FromURLQuery ¶

func FromURLQuery(query string) (Map, error)

FromURLQuery generates a new Obj by parsing the specified query.

For queries with multiple values, the first value is selected.

func MSI ¶

func MSI(keyAndValuePairs ...interface{}) Map

MSI creates a map[string]interface{} and puts it inside a new Map.

The arguments follow a key, value pattern.

Panics ¶

Panics if any key arugment is non-string or if there are an odd number of arguments.

Example ¶

To easily create Maps:

m := objx.MSI("name", "Mat", "age", 29, "subobj", objx.MSI("active", true))

// creates an Map equivalent to
m := objx.New(map[string]interface{}{"name": "Mat", "age": 29, "subobj": map[string]interface{}{"active": true}})

func MustFromBase64 ¶

func MustFromBase64(base64String string) Map

MustFromBase64 creates a new Obj containing the data specified in the Base64 string and panics if there is an error.

The string is an encoded JSON string returned by Base64

func MustFromJSON ¶

func MustFromJSON(jsonString string) Map

MustFromJSON creates a new Map containing the data specified in the jsonString.

Panics if the JSON is invalid.

func MustFromSignedBase64 ¶

func MustFromSignedBase64(base64String, key string) Map

MustFromSignedBase64 creates a new Obj containing the data specified in the Base64 string and panics if there is an error.

The string is an encoded JSON string returned by Base64

func MustFromURLQuery ¶

func MustFromURLQuery(query string) Map

MustFromURLQuery generates a new Obj by parsing the specified query.

For queries with multiple values, the first value is selected.

Panics if it encounters an error

func New ¶

func New(data interface{}) Map

New creates a new Map containing the map[string]interface{} in the data argument. If the data argument is not a map[string]interface, New attempts to call the MSI() method on the MSIConvertable interface to create one.

func (Map) Base64 ¶

func (m Map) Base64() (string, error)

Base64 converts the contained object to a Base64 string representation of the JSON string representation

func (Map) Copy ¶

func (m Map) Copy() Map

Copy creates a shallow copy of the Obj.

func (Map) Exclude ¶

func (d Map) Exclude(exclude []string) Map

Exclude returns a new Map with the keys in the specified []string excluded.

func (Map) Get ¶

func (m Map) Get(selector string) *Value

Get gets the value using the specified selector and returns it inside a new Obj object.

If it cannot find the value, Get will return a nil value inside an instance of Obj.

Get can only operate directly on map[string]interface{} and []interface.

Example ¶

To access the title of the third chapter of the second book, do:

o.Get("books[1].chapters[2].title")

func (Map) Has ¶

func (m Map) Has(selector string) bool

Has gets whether there is something at the specified selector or not.

If m is nil, Has will always return false.

func (Map) JSON ¶

func (m Map) JSON() (string, error)

JSON converts the contained object to a JSON string representation

func (Map) Merge ¶

func (m Map) Merge(merge Map) Map

Merge blends the specified map with a copy of this map and returns the result.

Keys that appear in both will be selected from the specified map. This method requires that the wrapped object be a map[string]interface{}

func (Map) MergeHere ¶

func (m Map) MergeHere(merge Map) Map

Merge blends the specified map with this map and returns the current map.

Keys that appear in both will be selected from the specified map. The original map will be modified. This method requires that the wrapped object be a map[string]interface{}

func (Map) MustBase64 ¶

func (m Map) MustBase64() string

MustBase64 converts the contained object to a Base64 string representation of the JSON string representation and panics if there is an error

func (Map) MustJSON ¶

func (m Map) MustJSON() string

MustJSON converts the contained object to a JSON string representation and panics if there is an error

func (Map) MustSignedBase64 ¶

func (m Map) MustSignedBase64(key string) string

MustSignedBase64 converts the contained object to a Base64 string representation of the JSON string representation and signs it using the provided key and panics if there is an error

func (Map) Set ¶

func (m Map) Set(selector string, value interface{}) Map

Set sets the value using the specified selector and returns the object on which Set was called.

Set can only operate directly on map[string]interface{} and []interface

Example ¶

To set the title of the third chapter of the second book, do:

o.Set("books[1].chapters[2].title","Time to Go")

func (Map) SignedBase64 ¶

func (m Map) SignedBase64(key string) (string, error)

SignedBase64 converts the contained object to a Base64 string representation of the JSON string representation and signs it using the provided key.

func (Map) Transform ¶

func (m Map) Transform(transformer func(key string, value interface{}) (string, interface{})) Map

Transform builds a new Obj giving the transformer a chance to change the keys and values as it goes. This method requires that the wrapped object be a map[string]interface{}

func (Map) TransformKeys ¶

func (m Map) TransformKeys(mapping map[string]string) Map

TransformKeys builds a new map using the specified key mapping.

Unspecified keys will be unaltered. This method requires that the wrapped object be a map[string]interface{}

func (Map) URLQuery ¶

func (m Map) URLQuery() (string, error)

URLQuery gets an encoded URL query representing the given Obj. This function requires that the wrapped object be a map[string]interface{}

func (Map) URLValues ¶

func (m Map) URLValues() url.Values

URLValues creates a url.Values object from an Obj. This function requires that the wrapped object be a map[string]interface{}

func (Map) Value ¶

func (m Map) Value() *Value

Value returns the internal value instance

type Value ¶

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

Value provides methods for extracting interface{} data in various types.

func (*Value) Bool ¶

func (v *Value) Bool(optionalDefault ...bool) bool

Bool gets the value as a bool, returns the optionalDefault value or a system default object if the value is the wrong type.

func (*Value) BoolSlice ¶

func (v *Value) BoolSlice(optionalDefault ...[]bool) []bool

BoolSlice gets the value as a []bool, returns the optionalDefault value or nil if the value is not a []bool.

func (*Value) CollectBool ¶

func (v *Value) CollectBool(collector func(int, bool) interface{}) *Value

CollectBool uses the specified collector function to collect a value for each of the bools in the slice. The data returned will be a []interface{}.

func (*Value) CollectComplex128 ¶

func (v *Value) CollectComplex128(collector func(int, complex128) interface{}) *Value

CollectComplex128 uses the specified collector function to collect a value for each of the complex128s in the slice. The data returned will be a []interface{}.

func (*Value) CollectComplex64 ¶

func (v *Value) CollectComplex64(collector func(int, complex64) interface{}) *Value

CollectComplex64 uses the specified collector function to collect a value for each of the complex64s in the slice. The data returned will be a []interface{}.

func (*Value) CollectFloat32 ¶

func (v *Value) CollectFloat32(collector func(int, float32) interface{}) *Value

CollectFloat32 uses the specified collector function to collect a value for each of the float32s in the slice. The data returned will be a []interface{}.

func (*Value) CollectFloat64 ¶

func (v *Value) CollectFloat64(collector func(int, float64) interface{}) *Value

CollectFloat64 uses the specified collector function to collect a value for each of the float64s in the slice. The data returned will be a []interface{}.

func (*Value) CollectInt ¶

func (v *Value) CollectInt(collector func(int, int) interface{}) *Value

CollectInt uses the specified collector function to collect a value for each of the ints in the slice. The data returned will be a []interface{}.

func (*Value) CollectInt16 ¶

func (v *Value) CollectInt16(collector func(int, int16) interface{}) *Value

CollectInt16 uses the specified collector function to collect a value for each of the int16s in the slice. The data returned will be a []interface{}.

func (*Value) CollectInt32 ¶

func (v *Value) CollectInt32(collector func(int, int32) interface{}) *Value

CollectInt32 uses the specified collector function to collect a value for each of the int32s in the slice. The data returned will be a []interface{}.

func (*Value) CollectInt64 ¶

func (v *Value) CollectInt64(collector func(int, int64) interface{}) *Value

CollectInt64 uses the specified collector function to collect a value for each of the int64s in the slice. The data returned will be a []interface{}.

func (*Value) CollectInt8 ¶

func (v *Value) CollectInt8(collector func(int, int8) interface{}) *Value

CollectInt8 uses the specified collector function to collect a value for each of the int8s in the slice. The data returned will be a []interface{}.

func (*Value) CollectInter ¶

func (v *Value) CollectInter(collector func(int, interface{}) interface{}) *Value

CollectInter uses the specified collector function to collect a value for each of the interface{}s in the slice. The data returned will be a []interface{}.

func (*Value) CollectMSI ¶

func (v *Value) CollectMSI(collector func(int, map[string]interface{}) interface{}) *Value

CollectMSI uses the specified collector function to collect a value for each of the map[string]interface{}s in the slice. The data returned will be a []interface{}.

func (*Value) CollectObjxMap ¶

func (v *Value) CollectObjxMap(collector func(int, Map) interface{}) *Value

CollectObjxMap uses the specified collector function to collect a value for each of the (Map)s in the slice. The data returned will be a []interface{}.

func (*Value) CollectStr ¶

func (v *Value) CollectStr(collector func(int, string) interface{}) *Value

CollectStr uses the specified collector function to collect a value for each of the strings in the slice. The data returned will be a []interface{}.

func (*Value) CollectUint ¶

func (v *Value) CollectUint(collector func(int, uint) interface{}) *Value

CollectUint uses the specified collector function to collect a value for each of the uints in the slice. The data returned will be a []interface{}.

func (*Value) CollectUint16 ¶

func (v *Value) CollectUint16(collector func(int, uint16) interface{}) *Value

CollectUint16 uses the specified collector function to collect a value for each of the uint16s in the slice. The data returned will be a []interface{}.

func (*Value) CollectUint32 ¶

func (v *Value) CollectUint32(collector func(int, uint32) interface{}) *Value

CollectUint32 uses the specified collector function to collect a value for each of the uint32s in the slice. The data returned will be a []interface{}.

func (*Value) CollectUint64 ¶

func (v *Value) CollectUint64(collector func(int, uint64) interface{}) *Value

CollectUint64 uses the specified collector function to collect a value for each of the uint64s in the slice. The data returned will be a []interface{}.

func (*Value) CollectUint8 ¶

func (v *Value) CollectUint8(collector func(int, uint8) interface{}) *Value

CollectUint8 uses the specified collector function to collect a value for each of the uint8s in the slice. The data returned will be a []interface{}.

func (*Value) CollectUintptr ¶

func (v *Value) CollectUintptr(collector func(int, uintptr) interface{}) *Value

CollectUintptr uses the specified collector function to collect a value for each of the uintptrs in the slice. The data returned will be a []interface{}.

func (*Value) Complex128 ¶

func (v *Value) Complex128(optionalDefault ...complex128) complex128

Complex128 gets the value as a complex128, returns the optionalDefault value or a system default object if the value is the wrong type.

func (*Value) Complex128Slice ¶

func (v *Value) Complex128Slice(optionalDefault ...[]complex128) []complex128

Complex128Slice gets the value as a []complex128, returns the optionalDefault value or nil if the value is not a []complex128.

func (*Value) Complex64 ¶

func (v *Value) Complex64(optionalDefault ...complex64) complex64

Complex64 gets the value as a complex64, returns the optionalDefault value or a system default object if the value is the wrong type.

func (*Value) Complex64Slice ¶

func (v *Value) Complex64Slice(optionalDefault ...[]complex64) []complex64

Complex64Slice gets the value as a []complex64, returns the optionalDefault value or nil if the value is not a []complex64.

func (*Value) Data ¶

func (v *Value) Data() interface{}

Data returns the raw data contained by this Value