sanitize

README

sanitize

sanitize file name

Installation

go get github.com/prajaraksh/sanitize

Usage

name := sanitize.Name(string)
clean := sanitize.Clean(string)

Documentation

Overview

Package sanitize goal is to have same fileName irrespective of platform. Incase of invalid fileName, a md5Sum of provided file is returned

Index

• Variables
• type Sanitize
  • func New() *Sanitize
  • func NewWithOpts(replaceStr string, maxLen int) (*Sanitize, error)
  • func (s *Sanitize) Clean(fileName string) string
  • func (s *Sanitize) Name(fileName string) string

Variables

var (
	// ErrCntrl represents `replaceStr` contains Control Characters
	ErrCntrl = errors.New("replaceStr can't contain control characters")
	// ErrInval represents `replaceStr` contains Invalid Characters
	ErrInval = errors.New("replaceStr can't contain ., <, >, :, \", /, \\, |, ?, *")

	// ErrLen represents `maxLen` is greater than 255
	ErrLen = errors.New("maxLen can't be greater than 255")
)

Types

type Sanitize

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

Sanitize struct

func New

func New() *Sanitize

New returns Sanitize

func NewWithOpts

func NewWithOpts(replaceStr string, maxLen int) (*Sanitize, error)

NewWithOpts returns Sanitize with opts set Certain conditions exist for replace Str and

func (*Sanitize) Clean

func (s *Sanitize) Clean(fileName string) string

Clean sanitizes ,removes invisible characters and repeated separators

func (*Sanitize) Name

func (s *Sanitize) Name(fileName string) string

Name sanitizies `fileName`