internal

Documentation

Overview

Package internal contains some internal functionalities needed for expipe. Config package contains the logic required for reading configuration from files. Any logic required for converting data types will land in the datatype package. The token package contains only logic required for generating request based tokens. Other commonly used logic are places in the internal package itself. There are numeric and string searches, logging setup, etc.

Index

• Constants
• func SanitiseURL(url string) (string, error)
• func StringInMapKeys(niddle string, haystack map[string]string) bool
• func StringInSlice(niddle string, haystack []string) bool
• type Entry
• type FieldLogger
• type InvalidURLError
  • func (i InvalidURLError) Error() string
• type Level
• type Logger
  • func DiscardLogger() *Logger
  • func GetLogger(level string) *Logger
  • func StandardLogger() *Logger

Examples

• SanitiseURL

Constants

const (
	// InfoLevel for Info level
	InfoLevel = logrus.InfoLevel
	// WarnLevel for Warn level
	WarnLevel = logrus.WarnLevel
	// DebugLevel for Debug level
	DebugLevel = logrus.DebugLevel
	// ErrorLevel for Error level
	ErrorLevel = logrus.ErrorLevel
)

Functions

func SanitiseURL

func SanitiseURL(url string) (string, error)

SanitiseURL prepends a protocol to the url if not defined, and checks if it's a valid url.

Example

This example shows how to sanitise a URL.

package main

import (
	"fmt"

	"github.com/arsham/expipe/internal"
)

func main() {
	res, err := internal.SanitiseURL("http localhost")
	fmt.Printf("Error: %v\n", err)
	fmt.Printf("Result: <%s>\n", res)

	res, err = internal.SanitiseURL("127.0.0.1")
	fmt.Printf("Error: %v\n", err)
	fmt.Printf("Result: <%s>\n", res)

	res, _ = internal.SanitiseURL("https://localhost.localdomain")
	fmt.Printf("Result: <%s>\n", res)

}

Output:

Error: invalid url: http localhost
Result: <>
Error: <nil>
Result: <http://127.0.0.1>
Result: <https://localhost.localdomain>

func StringInMapKeys

func StringInMapKeys(niddle string, haystack map[string]string) bool

StringInMapKeys returns true if niddle is in the haystack's keys

func StringInSlice

func StringInSlice(niddle string, haystack []string) bool

StringInSlice returns true if niddle is in the haystack

Types

type Entry

type Entry struct{ *logrus.Entry }

Entry embeds logrus.Entry

type FieldLogger

type FieldLogger logrus.FieldLogger

FieldLogger interface set by logrus

type InvalidURLError

type InvalidURLError string

InvalidURLError is returned when the URL is not a valid one.

func (InvalidURLError) Error

func (i InvalidURLError) Error() string

Error returns the string representation of the error.

type Level

type Level logrus.Level

Level type set by logrus

type Logger

type Logger struct{ *logrus.Logger }

Logger embeds logrus.Logger

func DiscardLogger

func DiscardLogger() *Logger

DiscardLogger returns a dummy logger. This is useful for tests when you don't want to actually write to the Stdout.

func GetLogger

func GetLogger(level string) *Logger

GetLogger returns the default logger with the given log level.

func StandardLogger

func StandardLogger() *Logger

StandardLogger returns an instance of Logger