tar

README

Tar

Purpose of the tar package is to enable components to process a set of files from StdIn and StdOut, so they can be pure

Documentation

Index

• Variables
• func CreateEntry(path string) func([]byte) FileEntry
• func LookupString(path string) func(FileList) O.Option[string]
• func Singleton(path string) func([]byte) FileList
• func UpsertBytes(path string) func([]byte) func(FileList) FileList
• func UpsertString(path string) func(string) func(FileList) FileList
• type FileEntry
• type FileList
  • func FromEntries(entries []FileEntry) FileList

Variables

var (
	// the empty file list
	Empty = RR.Empty[string, []byte]()
	// LookupBytes accesses a file as bytes from a file list
	LookupBytes = F.Flow2(
		cleanPath,
		RR.Lookup[[]byte, string],
	)
	// the monoid used to merge FileList objects
	Monoid = RR.UnionMonoid[string](SG.Last[[]byte]())
)

Functions

func CreateEntry

func CreateEntry(path string) func([]byte) FileEntry

CreateEntry constructs a file entry with byte content

func LookupString

func LookupString(path string) func(FileList) O.Option[string]

LookupString accesses a file as string from a file list

func Singleton

func Singleton(path string) func([]byte) FileList

Singleton returns a file list with one single entry

func UpsertBytes

func UpsertBytes(path string) func([]byte) func(FileList) FileList

UpsertBytes adds a file by path to a file list

func UpsertString

func UpsertString(path string) func(string) func(FileList) FileList

UpsertString adds a file by path to a file list

Types

type FileEntry

type FileEntry = T.Tuple2[string, []byte]

one entry in the file list

type FileList

type FileList = map[string][]byte

FileList represents a mapping from filepath to the byte value of a file

func FromEntries

func FromEntries(entries []FileEntry) FileList

FromEntries creates a file list from a set of entries