version: 1.10

package utf8

import "unicode/utf8"

Overview

Package utf8 implements functions and constants to support text encoded in
UTF-8. It includes functions to translate between runes and UTF-8 byte
sequences.

Index

Examples

Package files

utf8.go

Constants

  1. const (
  2.     RuneError = '\uFFFD'     // the "error" Rune or "Unicode replacement character"
  3.     RuneSelf  = 0x80         // characters below Runeself are represented as themselves in a single byte.
  4.     MaxRune   = '\U0010FFFF' // Maximum valid Unicode code point.
  5.     UTFMax    = 4            // maximum number of bytes of a UTF-8 encoded Unicode character.
  6. )

Numbers fundamental to the encoding.

func DecodeLastRune

  1. func DecodeLastRune(p []byte) (r rune, size int)

DecodeLastRune unpacks the last UTF-8 encoding in p and returns the rune and its
width in bytes. If p is empty it returns (RuneError, 0). Otherwise, if the
encoding is invalid, it returns (RuneError, 1). Both are impossible results for
correct, non-empty UTF-8.

An encoding is invalid if it is incorrect UTF-8, encodes a rune that is out of
range, or is not the shortest possible UTF-8 encoding for the value. No other
validation is performed.


Example:

  1. b := []byte("Hello, 世界")
  3. for len(b) > 0 {
  4.     r, size := utf8.DecodeLastRune(b)
  5.     fmt.Printf("%c %v\n", r, size)
  7.     b = b[:len(b)-size]
  8. }
  9. // Output:
  10. // 界 3
  11. // 世 3
  12. //   1
  13. // , 1
  14. // o 1
  15. // l 1
  16. // l 1
  17. // e 1
  18. // H 1

func DecodeLastRuneInString

  1. func DecodeLastRuneInString(s string) (r rune, size int)

DecodeLastRuneInString is like DecodeLastRune but its input is a string. If s is
empty it returns (RuneError, 0). Otherwise, if the encoding is invalid, it
returns (RuneError, 1). Both are impossible results for correct, non-empty
UTF-8.

An encoding is invalid if it is incorrect UTF-8, encodes a rune that is out of
range, or is not the shortest possible UTF-8 encoding for the value. No other
validation is performed.


Example:

  1. str := "Hello, 世界"
  3. for len(str) > 0 {
  4.     r, size := utf8.DecodeLastRuneInString(str)
  5.     fmt.Printf("%c %v\n", r, size)
  7.     str = str[:len(str)-size]
  8. }
  9. // Output:
  10. // 界 3
  11. // 世 3
  12. //   1
  13. // , 1
  14. // o 1
  15. // l 1
  16. // l 1
  17. // e 1
  18. // H 1

func DecodeRune

  1. func DecodeRune(p []byte) (r rune, size int)

DecodeRune unpacks the first UTF-8 encoding in p and returns the rune and its
width in bytes. If p is empty it returns (RuneError, 0). Otherwise, if the
encoding is invalid, it returns (RuneError, 1). Both are impossible results for
correct, non-empty UTF-8.

An encoding is invalid if it is incorrect UTF-8, encodes a rune that is out of
range, or is not the shortest possible UTF-8 encoding for the value. No other
validation is performed.


Example:

  1. b := []byte("Hello, 世界")
  3. for len(b) > 0 {
  4.     r, size := utf8.DecodeRune(b)
  5.     fmt.Printf("%c %v\n", r, size)
  7.     b = b[size:]
  8. }
  9. // Output:
  10. // H 1
  11. // e 1
  12. // l 1
  13. // l 1
  14. // o 1
  15. // , 1
  16. //   1
  17. // 世 3
  18. // 界 3

func DecodeRuneInString

  1. func DecodeRuneInString(s string) (r rune, size int)

DecodeRuneInString is like DecodeRune but its input is a string. If s is empty
it returns (RuneError, 0). Otherwise, if the encoding is invalid, it returns
(RuneError, 1). Both are impossible results for correct, non-empty UTF-8.

An encoding is invalid if it is incorrect UTF-8, encodes a rune that is out of
range, or is not the shortest possible UTF-8 encoding for the value. No other
validation is performed.


Example:

  1. str := "Hello, 世界"
  3. for len(str) > 0 {
  4.     r, size := utf8.DecodeRuneInString(str)
  5.     fmt.Printf("%c %v\n", r, size)
  7.     str = str[size:]
  8. }
  9. // Output:
  10. // H 1
  11. // e 1
  12. // l 1
  13. // l 1
  14. // o 1
  15. // , 1
  16. //   1
  17. // 世 3
  18. // 界 3

func EncodeRune

  1. func EncodeRune(p []byte, r rune) int

EncodeRune writes into p (which must be large enough) the UTF-8 encoding of the
rune. It returns the number of bytes written.


Example:

  1. r := '世'
  2. buf := make([]byte, 3)
  4. n := utf8.EncodeRune(buf, r)
  6. fmt.Println(buf)
  7. fmt.Println(n)
  8. // Output:
  9. // [228 184 150]
  10. // 3

func FullRune

  1. func FullRune(p []byte) bool

FullRune reports whether the bytes in p begin with a full UTF-8 encoding of a
rune. An invalid encoding is considered a full Rune since it will convert as a
width-1 error rune.


Example:

  1. buf := []byte{228, 184, 150} // 世
  2. fmt.Println(utf8.FullRune(buf))
  3. fmt.Println(utf8.FullRune(buf[:2]))
  4. // Output:
  5. // true
  6. // false

func FullRuneInString

  1. func FullRuneInString(s string) bool

FullRuneInString is like FullRune but its input is a string.


Example:

  1. str := "世"
  2. fmt.Println(utf8.FullRuneInString(str))
  3. fmt.Println(utf8.FullRuneInString(str[:2]))
  4. // Output:
  5. // true
  6. // false

func RuneCount

  1. func RuneCount(p []byte) int

RuneCount returns the number of runes in p. Erroneous and short encodings are
treated as single runes of width 1 byte.


Example:

  1. buf := []byte("Hello, 世界")
  2. fmt.Println("bytes =", len(buf))
  3. fmt.Println("runes =", utf8.RuneCount(buf))
  4. // Output:
  5. // bytes = 13
  6. // runes = 9

func RuneCountInString

  1. func RuneCountInString(s string) (n int)

RuneCountInString is like RuneCount but its input is a string.


Example:

  1. str := "Hello, 世界"
  2. fmt.Println("bytes =", len(str))
  3. fmt.Println("runes =", utf8.RuneCountInString(str))
  4. // Output:
  5. // bytes = 13
  6. // runes = 9

func RuneLen

  1. func RuneLen(r rune) int

RuneLen returns the number of bytes required to encode the rune. It returns -1
if the rune is not a valid value to encode in UTF-8.


Example:

  1. fmt.Println(utf8.RuneLen('a'))
  2. fmt.Println(utf8.RuneLen('界'))
  3. // Output:
  4. // 1
  5. // 3

func RuneStart

  1. func RuneStart(b byte) bool

RuneStart reports whether the byte could be the first byte of an encoded,
possibly invalid rune. Second and subsequent bytes always have the top two bits
set to 10.


Example:

  1. buf := []byte("a界")
  2. fmt.Println(utf8.RuneStart(buf[0]))
  3. fmt.Println(utf8.RuneStart(buf[1]))
  4. fmt.Println(utf8.RuneStart(buf[2]))
  5. // Output:
  6. // true
  7. // true
  8. // false

func Valid

  1. func Valid(p []byte) bool

Valid reports whether p consists entirely of valid UTF-8-encoded runes.


Example:

  1. valid := []byte("Hello, 世界")
  2. invalid := []byte{0xff, 0xfe, 0xfd}
  4. fmt.Println(utf8.Valid(valid))
  5. fmt.Println(utf8.Valid(invalid))
  6. // Output:
  7. // true
  8. // false

func ValidRune

  1. func ValidRune(r rune) bool

ValidRune reports whether r can be legally encoded as UTF-8. Code points that
are out of range or a surrogate half are illegal.


Example:

  1. valid := 'a'
  2. invalid := rune(0xfffffff)
  4. fmt.Println(utf8.ValidRune(valid))
  5. fmt.Println(utf8.ValidRune(invalid))
  6. // Output:
  7. // true
  8. // false

func ValidString

  1. func ValidString(s string) bool

ValidString reports whether s consists entirely of valid UTF-8-encoded runes.


Example:

  1. valid := "Hello, 世界"
  2. invalid := string([]byte{0xff, 0xfe, 0xfd})
  4. fmt.Println(utf8.ValidString(valid))
  5. fmt.Println(utf8.ValidString(invalid))
  6. // Output:
  7. // true
  8. // false