blocks

Documentation

Overview

package blocks contains the lowest level of IPFS data structures, the raw block with a checksum.

Index

• Variables
• type BasicBlock
  • func NewBlock(data []byte) *BasicBlock
  • func NewBlockWithCid(data []byte, c *cid.Cid) (*BasicBlock, error)
  • func (b *BasicBlock) Cid() *cid.Cid
  • func (b *BasicBlock) Loggable() map[string]interface{}
  • func (b *BasicBlock) Multihash() mh.Multihash
  • func (b *BasicBlock) RawData() []byte
  • func (b *BasicBlock) String() string
• type Block

Variables

var ErrWrongHash = errors.New("data did not match given hash!")

Types

type BasicBlock

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

Block is a singular block of data in ipfs

func NewBlock

func NewBlock(data []byte) *BasicBlock

NewBlock creates a Block object from opaque data. It will hash the data.

func NewBlockWithCid

func NewBlockWithCid(data []byte, c *cid.Cid) (*BasicBlock, error)

NewBlockWithHash creates a new block when the hash of the data is already known, this is used to save time in situations where we are able to be confident that the data is correct

func (*BasicBlock) Cid

func (b *BasicBlock) Cid() *cid.Cid

func (*BasicBlock) Loggable

func (b *BasicBlock) Loggable() map[string]interface{}

func (*BasicBlock) Multihash

func (b *BasicBlock) Multihash() mh.Multihash

func (*BasicBlock) RawData

func (b *BasicBlock) RawData() []byte

func (*BasicBlock) String

func (b *BasicBlock) String() string

type Block

type Block interface {
	RawData() []byte
	Cid() *cid.Cid
	String() string
	Loggable() map[string]interface{}
}