Documentation
¶
Overview ¶
Package encoding defines an interface for character encodings, such as Shift JIS and Windows 1252, that can convert to and from UTF-8.
Encoding implementations are provided in other packages, such as golang.org/x/text/encoding/charmap and golang.org/x/text/encoding/japanese.
Index ¶
Constants ¶
const ASCIISub = '\x1a'
ASCIISub is the ASCII substitute character, as recommended by https://unicode.org/reports/tr36/#Text_Comparison
Variables ¶
var ErrInvalidUTF8 = errors.New("encoding: invalid UTF-8")
ErrInvalidUTF8 means that a transformer encountered invalid UTF-8.
var UTF8Validator transform.Transformer = utf8Validator{}
UTF8Validator is a transformer that returns ErrInvalidUTF8 on the first input byte that is not valid UTF-8.
Functions ¶
This section is empty.
Types ¶
type Decoder ¶
type Decoder struct {
transform.Transformer
// contains filtered or unexported fields
}
A Decoder converts bytes to UTF-8. It implements transform.Transformer.
Transforming source bytes that are not of that encoding will not result in an error per se. Each byte that cannot be transcoded will be represented in the output by the UTF-8 encoding of '\uFFFD', the replacement rune.
func (*Decoder) Bytes ¶
Bytes converts the given encoded bytes to UTF-8. It returns the converted bytes or nil, err if any error occurred.
type Encoder ¶
type Encoder struct {
transform.Transformer
// contains filtered or unexported fields
}
An Encoder converts bytes from UTF-8. It implements transform.Transformer.
Each rune that cannot be transcoded will result in an error. In this case, the transform will consume all source byte up to, not including the offending rune. Transforming source bytes that are not valid UTF-8 will be replaced by `\uFFFD`. To return early with an error instead, use transform.Chain to preprocess the data with a UTF8Validator.
func HTMLEscapeUnsupported ¶
HTMLEscapeUnsupported wraps encoders to replace source runes outside the repertoire of the destination encoding with HTML escape sequences.
This wrapper exists to comply to URL and HTML forms requiring a non-terminating legacy encoder. The produced sequences may lead to data loss as they are indistinguishable from legitimate input. To avoid this issue, use UTF-8 encodings whenever possible.
func ReplaceUnsupported ¶
ReplaceUnsupported wraps encoders to replace source runes outside the repertoire of the destination encoding with an encoding-specific replacement.
This wrapper is only provided for backwards compatibility and legacy handling. Its use is strongly discouraged. Use UTF-8 whenever possible.
func (*Encoder) Bytes ¶
Bytes converts bytes from UTF-8. It returns the converted bytes or nil, err if any error occurred.
type Encoding ¶
type Encoding interface {
// NewDecoder returns a Decoder.
NewDecoder() *Decoder
// NewEncoder returns an Encoder.
NewEncoder() *Encoder
}
Encoding is a character set encoding that can be transformed to and from UTF-8.
var Nop Encoding = nop{}
Nop is the nop encoding. Its transformed bytes are the same as the source bytes; it does not replace invalid UTF-8 sequences.
var Replacement Encoding = replacement{}
Replacement is the replacement encoding. Decoding from the replacement encoding yields a single '\uFFFD' replacement rune. Encoding from UTF-8 to the replacement encoding yields the same as the source bytes except that invalid UTF-8 is converted to '\uFFFD'.
It is defined at http://encoding.spec.whatwg.org/#replacement
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package charmap provides simple character encodings such as IBM Code Page 437 and Windows 1252.
|
Package charmap provides simple character encodings such as IBM Code Page 437 and Windows 1252. |
|
Package htmlindex maps character set encoding names to Encodings as recommended by the W3C for use in HTML 5.
|
Package htmlindex maps character set encoding names to Encodings as recommended by the W3C for use in HTML 5. |
|
Package ianaindex maps names to Encodings as specified by the IANA registry.
|
Package ianaindex maps names to Encodings as specified by the IANA registry. |
|
Package internal contains code that is shared among encoding implementations.
|
Package internal contains code that is shared among encoding implementations. |
|
identifier
Package identifier defines the contract between implementations of Encoding and Index by defining identifiers that uniquely identify standardized coded character sets (CCS) and character encoding schemes (CES), which we will together refer to as encodings, for which Encoding implementations provide converters to and from UTF-8.
|
Package identifier defines the contract between implementations of Encoding and Index by defining identifiers that uniquely identify standardized coded character sets (CCS) and character encoding schemes (CES), which we will together refer to as encodings, for which Encoding implementations provide converters to and from UTF-8. |
|
Package japanese provides Japanese encodings such as EUC-JP and Shift JIS.
|
Package japanese provides Japanese encodings such as EUC-JP and Shift JIS. |
|
Package korean provides Korean encodings such as EUC-KR.
|
Package korean provides Korean encodings such as EUC-KR. |
|
Package simplifiedchinese provides Simplified Chinese encodings such as GBK.
|
Package simplifiedchinese provides Simplified Chinese encodings such as GBK. |
|
Package traditionalchinese provides Traditional Chinese encodings such as Big5.
|
Package traditionalchinese provides Traditional Chinese encodings such as Big5. |
|
Package unicode provides Unicode encodings such as UTF-16.
|
Package unicode provides Unicode encodings such as UTF-16. |
|
utf32
Package utf32 provides the UTF-32 Unicode encoding.
|
Package utf32 provides the UTF-32 Unicode encoding. |