utils

Documentation

Index

• Constants
• func AssetsDir(home string) string
• func ConfigPath(home string) string
• func DBDir(home string, name string) string
• func DidLegacyInformedConsent() bool
• func EngineDir(home string) string
• func EscapeAwareRuneCountInString(s string) int
• func Fatal(err error)
• func FileExists(path string) bool
• func GetOONIHome() (string, error)
• func Log(msg string, v ...interface{})
• func MakeResultsDir(home string, name string, ts time.Time) (string, error)
• func RequiredDirs(home string) []string
• func RightPad(str string, length int) string
• func TunnelDir(home string) string
• func WrapString(s string, lim uint) string

Constants

const ResultTimestamp = "2006-01-02T150405.999999999Z0700"

ResultTimestamp is a windows friendly timestamp

Functions

func AssetsDir

func AssetsDir(home string) string

AssetsDir returns the assets data dir for the given OONI Home

func ConfigPath

func ConfigPath(home string) string

ConfigPath returns the default path to the config file

func DBDir

func DBDir(home string, name string) string

DBDir returns the database dir for the given name

func DidLegacyInformedConsent

func DidLegacyInformedConsent() bool

DidLegacyInformedConsent checks if the user did the informed consent procedure in probe-legacy

func EngineDir

func EngineDir(home string) string

EngineDir returns the directory where ooni/probe-engine should store its private data given a specific OONI Home.

func EscapeAwareRuneCountInString

func EscapeAwareRuneCountInString(s string) int

EscapeAwareRuneCountInString counts the number of runes in a string taking into account escape sequences.

func Fatal

func Fatal(err error)

Fatal error

func FileExists

func FileExists(path string) bool

FileExists returns true if the specified path exists and is a regular file.

func GetOONIHome

func GetOONIHome() (string, error)

GetOONIHome returns the path to the OONI Home

func Log

func Log(msg string, v ...interface{})

Log outputs a log message.

func MakeResultsDir

func MakeResultsDir(home string, name string, ts time.Time) (string, error)

MakeResultsDir creates and returns a directory for the result

func RequiredDirs

func RequiredDirs(home string) []string

RequiredDirs returns the required ooni home directories

func RightPad

func RightPad(str string, length int) string

RightPad adds right padding in from of a string

func TunnelDir

func TunnelDir(home string) string

TunnelDir returns the directory where to store tunnels state

func WrapString

func WrapString(s string, lim uint) string

WrapString wraps the given string within lim width in characters.

Wrapping is currently naive and only happens at white-space. A future version of the library will implement smarter wrapping. This means that pathological cases can dramatically reach past the limit, such as a very long word. This is taken from: https://github.com/mitchellh/go-wordwrap/tree/f253961a26562056904822f2a52d4692347db1bd