escape

Documentation

Overview

Package escape provides percent and shell string escaping.

Index

• Constants
• func ForFilename(raw string) string
• func PercentDecode(raw string) ([]byte, error)
• func PercentEncode(strictness PercentStrictness, raw []byte) string
• func Shell(raw string) string
• type PercentStrictness

Constants

const (
	PercentFilenames = PercentStrictness("-.0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz")
	PercentDocket    = PercentStrictness("+-.0123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz")
)

const ShellSafe = "%+,-./0123456789:;=@ABCDEFGHIJKLMNOPQRSTUVWXYZ^_abcdefghijklmnopqrstuvwxyz"

Functions

func ForFilename

func ForFilename(raw string) string

ForFilename percent-encodes with a dash; its output always matches the regular expression `^[0-9A-Za-z-]*$`. ForFilename is injective.

func PercentDecode

func PercentDecode(raw string) ([]byte, error)

PercentDecode will upon encountering an encoding error emit utf8.RuneError and keep on going, returning a nil error iff no encoding error was encountered.

func PercentEncode

func PercentEncode(strictness PercentStrictness, raw []byte) string

func Shell

func Shell(raw string) string

Shell escapes any raw string to be correctly interpreted by a bash-like shell as one argument.

Types

type PercentStrictness

type PercentStrictness = string