quickbuilder

Documentation

Overview

Package quickbuilder is designed as a replacement for the existing ipfs-files constructor for a simple way to generate synthetic directory trees.

Index

• func Store(ls *ipld.LinkSystem, cb func(b *Builder) error) error
• type Builder
  • func (b *Builder) NewBytesFile(data []byte) Node
  • func (b *Builder) NewMapDirectory(entries map[string]Node) Node
• type Node

Functions

func Store

func Store(ls *ipld.LinkSystem, cb func(b *Builder) error) error

Store provides a builder context for making unixfs files and directories

Types

type Builder

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

Builder provides the linksystem context for saving files & directories

func (*Builder) NewBytesFile

func (b *Builder) NewBytesFile(data []byte) Node

NewBytesFile creates a unixfs file from byte contents

func (*Builder) NewMapDirectory

func (b *Builder) NewMapDirectory(entries map[string]Node) Node

NewMapDirectory creates a unixfs directory from a list of named entries

type Node

type Node interface {
	Size() (int64, error)
	Link() ipld.Link
}

A Node represents the most basic form of a file or directory