planetary

Documentation

Overview

Package planetary handles extraction of consumable data from IPLD objects

Index

• func DecodeStringToCID(contentHash string) (gocid.Cid, error)
• type Extractor
  • func NewPlanetaryExtractor(ipfsManager rtfs.Manager) *Extractor
  • func (e *Extractor) ExtractContents(contentHash string) ([]byte, error)
  • func (e *Extractor) ExtractObject(contentHash string, out interface{}) error

Functions

func DecodeStringToCID

func DecodeStringToCID(contentHash string) (gocid.Cid, error)

DecodeStringToCID is a wrapper used to convert a string to a cid object

Types

type Extractor

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

Extractor is how we grab data from ipld objects

func NewPlanetaryExtractor

func NewPlanetaryExtractor(ipfsManager rtfs.Manager) *Extractor

NewPlanetaryExtractor is used to generate our IPLD object extractor

func (*Extractor) ExtractContents

func (e *Extractor) ExtractContents(contentHash string) ([]byte, error)

ExtractContents is used to extract the contents from the ipld object

func (*Extractor) ExtractObject

func (e *Extractor) ExtractObject(contentHash string, out interface{}) error

ExtractObject is used to extract an IPLD object from a content hash