types

README

EDN Types

A library that contains the data types used by the EDN library.

Considerations

• Currently the Map type is an alias to map[Value]Value (Value being an interface provided by this library). In Go, maps do not support all type as keys.

  Since Sets are currently backed by map[Value]bool, the same restriction applies to set elements.

  Notably, Vector, Set, Map, etc., can not be map keys or set elements, despite being a valid expression in EDN.

  • Consider using the hash-set and hash-map implementations from [gohash][gohash]. The trade-off here will be further departure from native types as well as requiring all EDN types to meet the [Hasher and Equalser interfaces][gohash interfaces].

Documentation

Index

• type BigInt
• type Character
  • func (this Character) Equals(other Value) bool
  • func (this Character) String() string
• type Float
  • func (this Float) Equals(other Value) bool
  • func (this Float) String() string
• type Int
  • func (this Int) Equals(other Value) bool
  • func (this Int) String() string
• type Keyword
  • func (this Keyword) Equals(other Value) bool
  • func (this Keyword) String() string
• type List
  • func (this *List) Each(f func(Value, int))
  • func (this *List) Equals(other Value) bool
  • func (this *List) Insert(values ...Value) *List
  • func (this *List) Into(other Sequence) Sequence
  • func (this *List) Length() int
  • func (this *List) String() string
• type Map
  • func (this Map) Equals(other Value) bool
  • func (this Map) String() string
• type Rational
• type Sequence
• type Set
  • func (this Set) Each(f func(Value, int))
  • func (this Set) Equals(other Value) bool
  • func (this Set) Insert(value Value) Sequence
  • func (this Set) Into(other Sequence) Sequence
  • func (this Set) Length() int
  • func (this Set) String() string
• type String
  • func (this String) Equals(other Value) bool
  • func (this String) String() string
• type Value
• type Vector
  • func (this Vector) Each(f func(Value, int))
  • func (this Vector) Equals(other Value) bool
  • func (this Vector) Into(other Sequence) Sequence
  • func (this Vector) Length() int
  • func (this Vector) String() string

Types

type BigInt

type BigInt big.Int

BigInt represents EDN arbitrary precision integers.

type Character

type Character rune // TODO: possibly move out of string file

Character represents an EDN character: \a, \b, \c, \newline, etc...

func (Character) Equals

func (this Character) Equals(other Value) bool

Equals compares the Character to another Value for equality.

func (Character) String

func (this Character) String() string

String returns the EDN string representation of the Character.

type Float

type Float float64

Float represents EDN floats: 1.234, -1.2925e+9

func (Float) Equals

func (this Float) Equals(other Value) bool

Equals compares the Float to another Value for equality.

func (Float) String

func (this Float) String() string

String returns the EDN string representation of the Float.

type Int

type Int int64

Int represents EDN integers: 1, -5, 1000.

func (Int) Equals

func (this Int) Equals(other Value) bool

Equals compares the Int to another Value for equality.

func (Int) String

func (this Int) String() string

String returns the EDN string representation of the Int.

type Keyword

type Keyword string

Keyword represents an EDN keyword: :foo/bar or :baz

func (Keyword) Equals

func (this Keyword) Equals(other Value) bool

Equals compares the Keyword to another Value for equality.

func (Keyword) String

func (this Keyword) String() string

String returns the EDN string representation of the Keyword.

type List

type List linked.List

List is a type that represents an EDN list, such as: (1 2 3)

func (*List) Each

func (this *List) Each(f func(Value, int))

Each calls the provided function once for each item in its collection.

The provided function is passed the item and its index: f(item, index).

func (*List) Equals

func (this *List) Equals(other Value) bool

Equals compares the List to another Value for equality.

func (*List) Insert

func (this *List) Insert(values ...Value) *List

Insert inserts N Value items to the List and returns a pointer to the List.

func (*List) Into

func (this *List) Into(other Sequence) Sequence

Into returns a new Sequence (backed by a List) with the items from both the current List and the other Sequence.

func (*List) Length

func (this *List) Length() int

Length provides the current item count from the List.

func (*List) String

func (this *List) String() string

String returns the EDN string representation of the List.

type Map

type Map map[Value]Value

Map represents an EDN map: {:a "b", 123 true}

func (Map) Equals

func (this Map) Equals(other Value) bool

Equals compares the Map to another Value for equality.

func (Map) String

func (this Map) String() string

String returns the EDN string representation of the Map.

type Rational

type Rational big.Rat

Rational represents EDN rationals: 1/100, -7/5

type Sequence

type Sequence interface {
	Value

	Into(Sequence) Sequence
	Each(func(Value, int))
	Length() int
}

Sequence is a Value interface that provides a common abstraction for working with all EDN sequences (Lists, Maps, Sets, and Vectors)

type Set

type Set map[Value]bool

Set represents an EDN set: #{1 2 3}

func (Set) Each

func (this Set) Each(f func(Value, int))

Each calls the provided function once for each item in its collection.

The provided function is passed the item and its index: f(item, index).

func (Set) Equals

func (this Set) Equals(other Value) bool

Equals compares the Set to another Value for equality.

func (Set) Insert

func (this Set) Insert(value Value) Sequence

Insert adds a non-present Value into the Set and returns the Set. Adding an existing Value will have no effect.

func (Set) Into

func (this Set) Into(other Sequence) Sequence

Into returns a new Sequence (backed by a Set) with the items from both the current Set and the other Sequence.

func (Set) Length

func (this Set) Length() int

Length provides the current item count from the Set.

func (Set) String

func (this Set) String() string

String returns the EDN string representation of the Set.

type String

type String string

String represents an EDN string: "abc"

func (String) Equals

func (this String) Equals(other Value) bool

Equals compares the String to another Value for equality.

func (String) String

func (this String) String() string

String returns the EDN string representation of the String.

type Value

type Value interface {
	String() string
	Equals(Value) bool
}

Value is a generic interface to which all data returned by this library comply.

type Vector

type Vector []Value

Vector represents an EDN vector: [1 2 3]

func (Vector) Each

func (this Vector) Each(f func(Value, int))

Each calls the provided function once for each item in its collection.

The provided function is passed the item and its index: f(item, index).

func (Vector) Equals

func (this Vector) Equals(other Value) bool

Equals compares the Vector to another Value for equality.

func (Vector) Into

func (this Vector) Into(other Sequence) Sequence

Into returns a new Sequence (backed by a Vector) with the items from both the current Vector and the other Sequence.

func (Vector) Length

func (this Vector) Length() int

Length provides the current item count from the Vector.

func (Vector) String

func (this Vector) String() string

String returns the EDN string representation of the Vector.