feed

README

feed

import "github.com/smartcontractkit/data-streams-sdk/go/feed"

• Overview
• Index

Overview

Package report implements the Streams feed and feed schema version types.

Index

• type Feed
• type FeedVersion
• type ID
  • func (f *ID) FromString(s string) (err error)
  • func (f *ID) MarshalJSON() (b []byte, err error)
  • func (f *ID) String() (id string)
  • func (f *ID) UnmarshalJSON(b []byte) (err error)
  • func (f *ID) Version() FeedVersion

Package files

doc.go feed.go

type Feed

type Feed struct {
    FeedID ID `json:"feedID"`
}

Feed identifies the report stream ID.

type FeedVersion

type FeedVersion uint16

FeedVersion represents the feed report schema version

const (
    FeedVersion1 FeedVersion
    FeedVersion2
    FeedVersion3
)

type ID

type ID [32]byte

ID type

func (*ID) FromString

func (f *ID) FromString(s string) (err error)

func (*ID) MarshalJSON

func (f *ID) MarshalJSON() (b []byte, err error)

MarshalJSON implements json.Marshaler.

func (*ID) String

func (f *ID) String() (id string)

func (*ID) UnmarshalJSON

func (f *ID) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implements json.Unmarshaler.

func (*ID) Version

func (f *ID) Version() FeedVersion

---

Generated by godoc2md

Documentation

Overview

Package report implements the Streams feed and feed schema version types.

Index

• type Feed
• type FeedVersion
• type ID
  • func (f *ID) FromString(s string) (err error)
  • func (f *ID) MarshalJSON() (b []byte, err error)
  • func (f *ID) String() (id string)
  • func (f *ID) UnmarshalJSON(b []byte) (err error)
  • func (f *ID) Version() FeedVersion

Types

type Feed

type Feed struct {
	FeedID ID `json:"feedID"`
}

Feed identifies the report stream ID.

type FeedVersion

type FeedVersion uint16

FeedVersion represents the feed report schema version

const (
	FeedVersion1 FeedVersion
	FeedVersion2
	FeedVersion3
	FeedVersion4
)

type ID

type ID [32]byte

ID type

func (*ID) FromString

func (f *ID) FromString(s string) (err error)

func (*ID) MarshalJSON

func (f *ID) MarshalJSON() (b []byte, err error)

MarshalJSON implements json.Marshaler.

func (*ID) String

func (f *ID) String() (id string)

func (*ID) UnmarshalJSON

func (f *ID) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implements json.Unmarshaler.

func (*ID) Version

func (f *ID) Version() FeedVersion