stringutils

README

This package provides helper functions for dealing with strings

Documentation

Overview

Package stringutils provides helper functions for dealing with strings.

Index

• func GenerateRandomASCIIString(n int) string
• func GenerateRandomAlphaOnlyString(n int) string
• func InSlice(slice []string, s string) bool
• func ShellQuoteArguments(args []string) string
• func Truncate(s string, maxlen int) string
• type StrSlice
  • func NewStrSlice(parts ...string) *StrSlice
  • func (e *StrSlice) Len() int
  • func (e *StrSlice) MarshalJSON() ([]byte, error)
  • func (e *StrSlice) Slice() []string
  • func (e *StrSlice) ToString() string
  • func (e *StrSlice) UnmarshalJSON(b []byte) error

Functions

func GenerateRandomASCIIString

func GenerateRandomASCIIString(n int) string

GenerateRandomASCIIString generates an ASCII random stirng with length n.

func GenerateRandomAlphaOnlyString

func GenerateRandomAlphaOnlyString(n int) string

GenerateRandomAlphaOnlyString generates an alphabetical random string with length n.

func InSlice

func InSlice(slice []string, s string) bool

InSlice tests whether a string is contained in a slice of strings or not. Comparison is case insensitive

func ShellQuoteArguments

func ShellQuoteArguments(args []string) string

ShellQuoteArguments takes a list of strings and escapes them so they will be handled right when passed as arguments to an program via a shell

func Truncate

func Truncate(s string, maxlen int) string

Truncate truncates a string to maxlen.

Types

type StrSlice

type StrSlice struct {
	// contains filtered or unexported fields
}

StrSlice representes a string or an array of strings. We need to override the json decoder to accept both options.

func NewStrSlice

func NewStrSlice(parts ...string) *StrSlice

NewStrSlice creates an StrSlice based on the specified parts (as strings).

func (*StrSlice) Len

func (e *StrSlice) Len() int

Len returns the number of parts of the StrSlice.

func (*StrSlice) MarshalJSON

func (e *StrSlice) MarshalJSON() ([]byte, error)

MarshalJSON Marshals (or serializes) the StrSlice into the json format. This method is needed to implement json.Marshaller.

func (*StrSlice) Slice

func (e *StrSlice) Slice() []string

Slice gets the parts of the StrSlice as a Slice of string.

func (*StrSlice) ToString

func (e *StrSlice) ToString() string

ToString gets space separated string of all the parts.

func (*StrSlice) UnmarshalJSON

func (e *StrSlice) UnmarshalJSON(b []byte) error

UnmarshalJSON decodes the byte slice whether it's a string or an array of strings. This method is needed to implement json.Unmarshaler.