func/vendor/github.com/dimchansky/utfbom
David Simansky 4be773d9f6
chore: Update versions of major libraries used (#1277)
* Update buildpacks/pack deps

* Update tektoncd/cli deps

* Regen Linux only licenses

* Downgrade hinshin/vt10x to required version

* Fix deprecated warning in ssh config
2022-09-23 17:46:13 +00:00
..
.gitignore chore: Update versions of major libraries used (#1277) 2022-09-23 17:46:13 +00:00
.travis.yml chore: Update versions of major libraries used (#1277) 2022-09-23 17:46:13 +00:00
LICENSE chore: Update versions of major libraries used (#1277) 2022-09-23 17:46:13 +00:00
README.md chore: Update versions of major libraries used (#1277) 2022-09-23 17:46:13 +00:00
utfbom.go chore: Update versions of major libraries used (#1277) 2022-09-23 17:46:13 +00:00

README.md

utfbom Godoc License Build Status Go Report Card Coverage Status

The package utfbom implements the detection of the BOM (Unicode Byte Order Mark) and removing as necessary. It can also return the encoding detected by the BOM.

Installation

go get -u github.com/dimchansky/utfbom

Example

package main

import (
	"bytes"
	"fmt"
	"io/ioutil"

	"github.com/dimchansky/utfbom"
)

func main() {
	trySkip([]byte("\xEF\xBB\xBFhello"))
	trySkip([]byte("hello"))
}

func trySkip(byteData []byte) {
	fmt.Println("Input:", byteData)

	// just skip BOM
	output, err := ioutil.ReadAll(utfbom.SkipOnly(bytes.NewReader(byteData)))
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println("ReadAll with BOM skipping", output)

	// skip BOM and detect encoding
	sr, enc := utfbom.Skip(bytes.NewReader(byteData))
	fmt.Printf("Detected encoding: %s\n", enc)
	output, err = ioutil.ReadAll(sr)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println("ReadAll with BOM detection and skipping", output)
	fmt.Println()
}

Output:

$ go run main.go
Input: [239 187 191 104 101 108 108 111]
ReadAll with BOM skipping [104 101 108 108 111]
Detected encoding: UTF8
ReadAll with BOM detection and skipping [104 101 108 108 111]

Input: [104 101 108 108 111]
ReadAll with BOM skipping [104 101 108 108 111]
Detected encoding: Unknown
ReadAll with BOM detection and skipping [104 101 108 108 111]