README
¶
Hannibal / unit
This package wraps a number of common data values with conversions used in ActivityStreams. This is important because JSON-LD allows any piece of data to be represented in multiple formats. This wrapper allows safe access to indidividual values even when there are nil values slices, or maps of values present.
Usage
value := property.NewValue("http://foo.com")
foo.Raw() // returns "foo"
// Traverse Arrays
foo.Len() // returns 1
foo.Head().Raw() // returns "http://foo.com"
foo.Tail().Raw() // returns a nil value
// Represent maps
foo.Map() // returns a map with "id"="http://foo.com"
foo.Set("name", "Foo") // converts foo to a map and sets a new property
foo.Get("name").Raw() // returns "Foo"
Interfaces
Everything implements the property.Value interface, which provides several low-level manipulations for reading, writing, and transforming values. You can implement this interface in other packages to use other custom types with the rest of the hannibal library.
Documentation
¶
Index ¶
- func IsBool(value any) bool
- func IsFloat(value any) bool
- func IsInt(value any) bool
- func IsInt64(value any) bool
- func IsMap(value any) bool
- func IsSlice(value any) bool
- func IsString(value any) bool
- func IsTime(value any) bool
- type Bool
- func (value Bool) Bool() bool
- func (value Bool) Clone() Value
- func (value Bool) Get(_ string) Value
- func (value Bool) Head() Value
- func (value Bool) IsBool() bool
- func (value Bool) IsNil() bool
- func (value Bool) Len() int
- func (value Bool) Map() map[string]any
- func (value Bool) Raw() any
- func (value Bool) Set(property string, propertyValue any) Value
- func (value Bool) String() string
- func (value Bool) Tail() Value
- type BoolGetter
- type Float
- func (value Float) Clone() Value
- func (value Float) Float() float64
- func (value Float) Get(_ string) Value
- func (value Float) Head() Value
- func (value Float) IsFloat() bool
- func (value Float) IsNil() bool
- func (value Float) Len() int
- func (value Float) Map() map[string]any
- func (value Float) Raw() any
- func (value Float) Set(propertyName string, propertyValue any) Value
- func (value Float) String() string
- func (value Float) Tail() Value
- type FloatGetter
- type Int
- func (value Int) Clone() Value
- func (value Int) Get(_ string) Value
- func (value Int) Head() Value
- func (value Int) Int() int
- func (value Int) Int64() int64
- func (value Int) IsInt() bool
- func (value Int) IsInt64() bool
- func (value Int) IsNil() bool
- func (value Int) Len() int
- func (value Int) Map() map[string]any
- func (value Int) Raw() any
- func (value Int) Set(propertyName string, propertyValue any) Value
- func (value Int) String() string
- func (value Int) Tail() Value
- type Int64
- func (value Int64) Clone() Value
- func (value Int64) Get(_ string) Value
- func (value Int64) Head() Value
- func (value Int64) Int() int
- func (value Int64) Int64() int64
- func (value Int64) IsInt() bool
- func (value Int64) IsInt64() bool
- func (value Int64) IsNil() bool
- func (value Int64) Len() int
- func (value Int64) Map() map[string]any
- func (value Int64) Raw() any
- func (value Int64) Set(propertyName string, propertyValue any) Value
- func (value Int64) String() string
- func (value Int64) Tail() Value
- type Int64Getter
- type IntGetter
- type IsBooler
- type IsFloater
- type IsInt64er
- type IsInter
- type IsMapper
- type IsSlicer
- type IsStringer
- type IsTimeer
- type Map
- func (value Map) Clone() Value
- func (value Map) Get(name string) Value
- func (value Map) Head() Value
- func (value Map) IsMap() bool
- func (value Map) IsNil() bool
- func (value Map) Len() int
- func (value Map) Map() map[string]any
- func (value Map) MapKeys() []string
- func (value Map) Raw() any
- func (value Map) Set(name string, newValue any) Value
- func (value Map) String() string
- func (value Map) Tail() Value
- type MapGetter
- type Nil
- func (value Nil) Clone() Value
- func (value Nil) Get(string) Value
- func (value Nil) Head() Value
- func (value Nil) IsNil() bool
- func (value Nil) Len() int
- func (value Nil) Map() map[string]any
- func (value Nil) Raw() any
- func (value Nil) Set(string, any) Value
- func (value Nil) String() string
- func (value Nil) Tail() Value
- type Slice
- func (value Slice) Clone() Value
- func (value Slice) Get(name string) Value
- func (value Slice) Head() Value
- func (value Slice) IsNil() bool
- func (value Slice) IsSlice() bool
- func (value Slice) Len() int
- func (value Slice) Map() map[string]any
- func (value Slice) Raw() any
- func (value Slice) Set(name string, newValue any) Value
- func (value Slice) Slice() []any
- func (value Slice) String() string
- func (value Slice) Tail() Value
- type SliceGetter
- type String
- func (value String) Clone() Value
- func (value String) Get(propertyName string) Value
- func (value String) Head() Value
- func (value String) IsNil() bool
- func (value String) IsString() bool
- func (value String) Len() int
- func (value String) Map() map[string]any
- func (value String) Raw() any
- func (value String) Set(propertyName string, propertyValue any) Value
- func (value String) String() string
- func (value String) Tail() Value
- type StringGetter
- type Time
- func (value Time) Clone() Value
- func (value Time) Get(_ string) Value
- func (value Time) Head() Value
- func (value Time) IsNil() bool
- func (value Time) IsTime() bool
- func (value Time) Len() int
- func (value Time) Map() map[string]any
- func (value Time) Raw() any
- func (value Time) Set(propertyName string, propertyValue any) Value
- func (value Time) String() string
- func (value Time) Tail() Value
- func (value Time) Time() time.Time
- type TimeGetter
- type Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type BoolGetter ¶
type BoolGetter interface {
// Bool returns a value typed as a bool
Bool() bool
}
BoolGetter is an optional interface that should be implemented by any property.Value that contains a bool
type Float ¶
type Float float64
type FloatGetter ¶
type FloatGetter interface {
// Float returns the value typed as a float64
Float() float64
}
FloatGetter is an optional interface that should be implemented by any property.Value that contains a float64
type Int64Getter ¶
type Int64Getter interface {
// Int64 returns the value typed as an int64
Int64() int64
}
Int64Getter is an optional interface that should be implemented by any property.Value that contains an int64
type IntGetter ¶
type IntGetter interface {
// Int returns the value typed as an int
Int() int
}
IntGetter is an optional interface that should be implemented by any property.Value that contains an int
type IsStringer ¶
type MapGetter ¶
type MapGetter interface {
// Map returns the value typed as a map[string]any
Map() map[string]any
}
MapGetter is an optional interface that should be implemented by any property.Value that contains a map[string]any
type Slice ¶
type Slice []any
type SliceGetter ¶
type SliceGetter interface {
// Slice returns the value typed as a []any
Slice() []any
}
SliceGetter is an optional interface that should be implemented by any property.Value that contains a []any
type String ¶
type String string
type StringGetter ¶
type StringGetter interface {
// String returns the value typed as a string
String() string
}
StringGetter is an optional interface that should be implemented by any property.Value that contains a string
type Time ¶
type TimeGetter ¶
TimeGetter is an optional interface that should be implemented by any property.Value that contains a time.Time
type Value ¶
type Value interface {
// Get returns a value of the given property
Get(string) Value
// Set returns the value with the given property set
Set(string, any) Value
// Head returns the first value in a slices, or the value itself if it is not a slice
Head() Value
// Tail returns all values in a slice except the first
Tail() Value
// Len returns the number of elements in the value
Len() int
// IsNil returns TRUE if the value is empty
IsNil() bool
// Map returns the map representation of this value
Map() map[string]any
// Raw returns the raw, unwrapped value being stored
Raw() any
// Clone returns a deep copy of a value
Clone() Value
}
Value is a wrapper for any kind of value that might be used in a streams.Document
Source Files
Click to show internal directories.
Click to hide internal directories.