datatype

Documentation

Index

• Constants
• Variables
• type ByteType
  • func (b ByteType) String() string
• type Container
  • func NewContainer(list []DataType) *Container
  • func (c *Container) Add(d ...DataType)
  • func (c *Container) Error() error
  • func (c *Container) Len() int
  • func (c *Container) List() []DataType
  • func (c *Container) String(timestamp time.Time) string
• type DataContainer
  • func JobResultDataTypes(r io.Reader) DataContainer
• type DataType
  • func FromJason(key string, value jason.Value) (DataType, error)
• type FloatListType
  • func (fl FloatListType) String() string
• type FloatType
  • func (f FloatType) String() string
• type GCListType
  • func (flt GCListType) String() string
• type StringType
  • func (s StringType) String() string

Examples

• FromJason (FloatType)
• FromJason (MalformedInput)
• FromJason (StringType)

Constants

const (
	// BYTE ..
	BYTE = 1.0
	// KILOBYTE ..
	KILOBYTE = 1024 * BYTE
	// MEGABYTE ..
	MEGABYTE = 1024 * KILOBYTE
)

Variables

var ErrUnidentifiedJason = errors.New("unidentified jason value")

ErrUnidentifiedJason .

Types

type ByteType

type ByteType struct {
	Key   string
	Value float64
}

ByteType represents a pair of key values in which the value represents bytes It converts the value to MB

func (ByteType) String

func (b ByteType) String() string

String satisfies the Stringer interface

type Container

type Container struct {
	Err error
	// contains filtered or unexported fields
}

Container satisfies the DataContainer and error interfaces

func NewContainer

func NewContainer(list []DataType) *Container

NewContainer returns a new container

func (*Container) Add

func (c *Container) Add(d ...DataType)

Add adds to the list

func (*Container) Error

func (c *Container) Error() error

Error returns the error

func (*Container) Len

func (c *Container) Len() int

Len returns the length of the data

func (*Container) List

func (c *Container) List() []DataType

List returns the data The error is not provided here, please check the Err value

func (*Container) String

func (c *Container) String(timestamp time.Time) string

TODO: Use JSON encoder instead

type DataContainer

type DataContainer interface {
	// Returns the list. You should not update this list as it is a shared list and anyone can read from it.
	// If you append to this list, there is a chance you are not refering to the same underlying array in memory.
	List() []DataType
	Len() int

	String(timestamp time.Time) string
	// Returns the Err value
	Error() error
}

DataContainer is an interface for holding a list of DataType. I'm aware of the container/list package, which is awesome, but I needed to guard this with a mutex. To iterate over this contaner:

for i := 0; i < d.Len(); i++ {
    item := d.Get(i)
}

func JobResultDataTypes

func JobResultDataTypes(r io.Reader) DataContainer

JobResultDataTypes generates a list of DataType and puts them inside the DataContainer

type DataType

type DataType interface {
	fmt.Stringer
}

DataType implements Stringer and Marshal/Unmarshal

func FromJason

func FromJason(key string, value jason.Value) (DataType, error)

FromJason returns an instance of DataType from jason value

Example (FloatType)

j, _ := jason.NewValueFromBytes([]byte("666.6"))
result, err := FromJason("some float", *j)
fmt.Printf("error: %v\n", err)
fmt.Printf("Type: %v\n", reflect.TypeOf(result))
r := result.(*FloatType)
fmt.Printf("Result key: %s\n", r.Key)
fmt.Printf("Result value: %f\n", r.Value)
fmt.Printf("String representation: %s\n", result.String())

Output:

error: <nil>
Type: *datatype.FloatType
Result key: some float
Result value: 666.600000
String representation: "some float":666.600000

Example (MalformedInput)

j, _ := jason.NewValueFromBytes([]byte(`{malformed object}`))
result, err := FromJason("ignored", *j)
fmt.Printf("error: %v\n", err)
fmt.Printf("Type: %v\n", reflect.TypeOf(result))

Output:

error: unidentified jason value
Type: <nil>

Example (StringType)

j, _ := jason.NewValueFromBytes([]byte(`"some string"`))
result, err := FromJason("string key", *j)
fmt.Printf("error: %v\n", err)
fmt.Printf("Type: %v\n", reflect.TypeOf(result))
r := result.(*StringType)
fmt.Printf("Result key: %s\n", r.Key)
fmt.Printf("Result value: %s\n", r.Value)
fmt.Printf("String representation: %s\n", result.String())

Output:

error: <nil>
Type: *datatype.StringType
Result key: string key
Result value: some string
String representation: "string key":"some string"

type FloatListType

type FloatListType struct {
	Key   string
	Value []float64
}

FloatListType represents a pair of key values that the value is a list of floats

func (FloatListType) String

func (fl FloatListType) String() string

String satisfies the Stringer interface

type FloatType

type FloatType struct {
	Key   string
	Value float64
}

FloatType represents a pair of key values that the value is a float64

func (FloatType) String

func (f FloatType) String() string

String satisfies the Stringer interface

type GCListType

type GCListType struct {
	Key   string
	Value []uint64
}

GCListType represents a pair of key values of GC list info

func (GCListType) String

func (flt GCListType) String() string

String satisfies the Stringer interface

type StringType

type StringType struct {
	Key   string
	Value string
}

StringType represents a pair of key values that the value is a string

func (StringType) String

func (s StringType) String() string

String satisfies the Stringer interface