utils

Documentation

Overview

Contains various utilities used throughout the program. Shouldn't depend on any other part of the program in order to avoid cyclic imports.

data.go, previously various files such as in.go, min.go, slicesEqual.go, etc. contains code for handling various types of data.

Index

• func Delete(path string) error
• func Err(err error, a ...string)
• func Errs(errs []error)
• func GetBreadcrumbs(url string) ([]string, error)
• func GetDoc(url string) (*goquery.Document, error)
• func GetFileHash[T constraints.Integer](path string, bufSize T, hash hash.Hash) ([]byte, error)
• func GetFileMD5[T constraints.Integer](path string, bufSize T) ([]byte, error)
• func GetUpdated(url string) (string, error)
• func In[T comparable](slice []T, item T) bool
• func Info(msg string, a ...any)
• func Min[T constraints.Ordered](a T, numbers ...T) T
• func MonthStrToInt(month string) time.Month
• func ParseWorkshopTimestamp(timestamp string) (time.Time, bool)
• func Sanitise[S ~string](str S) (string, error)
• func SlicesEqual[T constraints.Ordered](a, b []T) bool
• func Test()
• func Unzip(src, dest string) error
• func Warn(warning string, a ...any)
• func WorkshopIDFromURL(url string) (int, error)
• func WorkshopIDToURL(id any) (string, bool)

Functions

func Delete

func Delete(path string) error

Deletes a file.

func Err

func Err(err error, a ...string)

func Errs

func Errs(errs []error)

func GetBreadcrumbs

func GetBreadcrumbs(url string) ([]string, error)

func GetDoc

func GetDoc(url string) (*goquery.Document, error)

Gets the goquery document of a given web page.

func GetFileHash

func GetFileHash[T constraints.Integer](path string, bufSize T, hash hash.Hash) ([]byte, error)

func GetFileMD5

func GetFileMD5[T constraints.Integer](path string, bufSize T) ([]byte, error)

func GetUpdated

func GetUpdated(url string) (string, error)

Gets the Updated timestamp

func In

func In[T comparable](slice []T, item T) bool

Checks if a slice of strings contains an given string.

func Info

func Info(msg string, a ...any)

func Min

func Min[T constraints.Ordered](a T, numbers ...T) T

Pass in any non-zero number of orderables and get back the one that's "smallest" (i.e. it < the rest).

Uses args `a` and `numbers` to ensure at least one value is given.

func MonthStrToInt

func MonthStrToInt(month string) time.Month

func ParseWorkshopTimestamp

func ParseWorkshopTimestamp(timestamp string) (time.Time, bool)

func Sanitise

func Sanitise[S ~string](str S) (string, error)

Replaces accents (e.g. 'é' -> 'e'). Converts to lowercase. Replaces whitespace with underscores. Removes all illegal characters.

func SlicesEqual

func SlicesEqual[T constraints.Ordered](a, b []T) bool

Checks if the items and order of two slices are equal

func Test

func Test()

used to check if i get up to a certain point

func Unzip

func Unzip(src, dest string) error

Based off of https://stackoverflow.com/a/24792688

func Warn

func Warn(warning string, a ...any)

func WorkshopIDFromURL

func WorkshopIDFromURL(url string) (int, error)

Extracts the Workshop ID from its URL.

func WorkshopIDToURL

func WorkshopIDToURL(id any) (string, bool)

Converts a Workshop ID to a Workshop URL