writers

Documentation

Index

• type DryRunWriter
  • func NewDryRunWritersFactory(w io.Writer) DryRunWriter
• type FSWriter
  • func (f *FSWriter) Write(name, path string, docBlob []byte, node *manifest.Node) error
• type Writer

Types

type DryRunWriter

type DryRunWriter interface {
	// GetWriter creates DryRunWriters writing to the
	// same backend but for different roots (e.g. for
	// resources and docs)
	GetWriter(root string) Writer
	// Flush wraps up dry run writing and flushes
	// results to the underlying writer (e.g. os.Stdout)
	Flush() bool
}

DryRunWriter is the functional interface for working with dry run writers

func NewDryRunWritersFactory

func NewDryRunWritersFactory(w io.Writer) DryRunWriter

NewDryRunWritersFactory creates factory for DryRunWriters writing to the same backend but for different roots (e.g. for resources and docs)

type FSWriter

type FSWriter struct {
	Root string
	Ext  string
	Hugo bool
}

FSWriter is implementation of Writer interface for writing blobs to the file system

func (*FSWriter) Write

func (f *FSWriter) Write(name, path string, docBlob []byte, node *manifest.Node) error

type Writer

type Writer interface {
	Write(name, path string, resourceContent []byte, node *manifest.Node) error
}

Writer writes blobs with name to a given path