util

Documentation

Overview

Package util contains a few simple utilites that has no internal dependencies. This is to encourage reuse of code.

Index

• func Debug(name string) func(string, ...interface{})
• func Download(url, destdir string) (string, error)
• func Markdown(s string) string
• func Parallel(f ...func())
• func Spawn(N int, fn func(i int))
• func SpawnWithLimit(N, limit int, fn func(i int))
• type StringList
  • func (s *StringList) Add(values ...string)
  • func (s *StringList) Contains(value string) bool
  • func (s *StringList) Join(sep string) string
  • func (s *StringList) Sprint(a ...interface{})
  • func (s *StringList) Sprintf(format string, a ...interface{})

Functions

func Debug

func Debug(name string) func(string, ...interface{})

Debug will return a debug(format, arg, arg...) function for which messages will be printed if the DEBUG environment variable is set.

This is useful for development debugging only. Do not use this for messages that has any value in production.

func Download

func Download(url, destdir string) (string, error)

Download downloads the request file in the url

func Markdown

func Markdown(s string) string

Markdown strips space indentation and replaces ' with `, allowing for markdown to be written as indended multi-line strings.

func Parallel

func Parallel(f ...func())

Parallel takes a list of functions and calls them all in concurrently, returning when all the functions are done.

This doesn't have any nice error or panic handling and is aimed as construct to be used inside other functions, mainly to reduce boiler-plate.

func Spawn

func Spawn(N int, fn func(i int))

Spawn N go routines and wait for them to return.

This utility is smart when instantiating elements in an array concurrently.

func SpawnWithLimit

func SpawnWithLimit(N, limit int, fn func(i int))

SpawnWithLimit N go routines running at-most limit in parallel and wait for them to return.

This utility is smart when instantiating elements in an array concurrently.

Types

type StringList

type StringList []string

StringList is a list of strings and useful methods

func (*StringList) Add

func (s *StringList) Add(values ...string)

Add a list of strings

func (*StringList) Contains

func (s *StringList) Contains(value string) bool

Contains returns true if s contains value

func (*StringList) Join

func (s *StringList) Join(sep string) string

Join concatenates elements fo the list with given separator

func (*StringList) Sprint

func (s *StringList) Sprint(a ...interface{})

Sprint adds a string using fmt.Sprint syntax

func (*StringList) Sprintf

func (s *StringList) Sprintf(format string, a ...interface{})

Sprintf adds a string using fmt.Sprintf syntax