Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

htmlstream

package module

Go to main page

Versions in this module

v0

v0.0.2

Oct 29, 2026

Changes in this version

type Matcher

+ func AttrNSEquals(ns, local, value string) Matcher

v0.0.1

Oct 29, 2026

Changes in this version

+ const DefaultChunkSize

+ const DefaultMaxDepth

+ const DefaultMaxHold

+ const DefaultMaxStackBytes

+ const DefaultMaxTokenSize

+ const NamespaceMathML

+ const NamespaceSVG

+ const NamespaceXHTML

+ const NamespaceXLink

+ const NamespaceXML

+ const NamespaceXMLNS

+ var ErrHeldOpen = errors.New(...)

+ var ErrHoldLimit = errors.New("htmlstream: held output exceeds MaxHold")

+ var ErrHoldReleased = errors.New("htmlstream: hold already released")

+ var ErrIncompleteTag = errors.New("htmlstream: can't edit an incomplete start tag")

+ var ErrInvalidOp = errors.New("htmlstream: invalid operation")

+ var ErrTokenTooLarge = errors.New("htmlstream: token too large")

+ var ErrUnsupportedEncoding = errors.New("htmlstream: unsupported encoding (utf-16 or utf-32)")

+ var ErrUntrackedLimit = errors.New("htmlstream: too many untracked elements (MaxDepth) with pending operations")

+ func AdjustMathMLAttrName(lname string) string

+ func AdjustSVGAttrName(lname string) string

+ func AdjustSVGTagName(lname string) string

+ func AppendCDATA[S ~string | ~[]byte](dst []byte, text S) []byte

+ func AppendComment[S ~string | ~[]byte](dst []byte, text S) []byte

+ func AppendElement[S ~string | ~[]byte](dst []byte, name string, text S, attrs ...string) []byte

+ func AppendEndTag(dst []byte, name string) []byte

+ func AppendEscapeAttr[S ~string | ~[]byte](dst []byte, s S) []byte

+ func AppendEscapeText[S ~string | ~[]byte](dst []byte, s S) []byte

+ func AppendProcInst[S ~string | ~[]byte](dst []byte, target string, data S) []byte

+ func AppendStartTag(dst []byte, name string, selfClosing bool, attrs ...string) []byte

+ func AppendXMLChars[S ~string | ~[]byte](dst []byte, s S) ([]byte, bool)

+ func ValidXMLChars[S ~string | ~[]byte](s S) bool

+ func ValidXMLName(name string) bool

+ type Attr struct

+ func (a Attr) AppendName(dst []byte) []byte

+ func (a Attr) AppendValue(dst []byte) []byte

+ func (a Attr) HasValue() bool

+ func (a Attr) Is(name string) bool

+ func (a Attr) Local() []byte

+ func (a Attr) Name() []byte

+ func (a Attr) Prefix() []byte

+ func (a Attr) Quote() byte

+ func (a Attr) Raw() []byte

+ func (a Attr) RawValue() []byte

+ func (a Attr) Value() string

+ type Element struct

+ func (e Element) AppendLocalName(dst []byte) []byte

+ func (e Element) Attr(name string) (Attr, bool)

+ func (e Element) AttrAt(i int) Attr

+ func (e Element) AttrNS(ns, local string) (Attr, bool)

+ func (e Element) AttrNamespace(a Attr) string

+ func (e Element) Attrs() iter.Seq[Attr]

+ func (e Element) HTMLRules() bool

+ func (e Element) HasAttr(name string) bool

+ func (e Element) Is(name string) bool

+ func (e Element) Local() []byte

+ func (e Element) LocalIs(name string) bool

+ func (e Element) NS() string

+ func (e Element) Name() []byte

+ func (e Element) NumAttrs() int

+ func (e Element) Pos() Pos

+ func (e Element) Prefix() []byte

+ type Hold struct

+ type Kind uint8

+ const CDATA

+ const Comment

+ const Doctype

+ const EndTag

+ const ProcInst

+ const StartTag

+ const Text

+ func (k Kind) String() string

+ type Matcher func(*Token) bool

+ func And(ms ...Matcher) Matcher

+ func AttrEquals(name, value string) Matcher

+ func AttrFunc(name string, fn func(value []byte) bool) Matcher

+ func AttrHasWord(name, word string) Matcher

+ func AttrNSFunc(ns, local string, fn func(value []byte) bool) Matcher

+ func HasAttr(name string) Matcher

+ func HasAttrNS(ns, local string) Matcher

+ func HasClass(class string) Matcher

+ func Not(m Matcher) Matcher

+ func Or(ms ...Matcher) Matcher

+ func Tag(name string, ms ...Matcher) Matcher

+ func TagNS(ns, local string, ms ...Matcher) Matcher

+ type Mode uint8

+ const HTML

+ const Universal

+ const XML

+ func (m Mode) String() string

+ type Pos int64

+ type Reader struct

+ func NewReader(r io.Reader) *Reader

+ func (r *Reader) All() iter.Seq[*Token]

+ func (r *Reader) Children() iter.Seq[*Token]

+ func (r *Reader) Depth() int

+ func (r *Reader) EffectiveMode() Mode

+ func (r *Reader) Err() error

+ func (r *Reader) Find(m Matcher) bool

+ func (r *Reader) LookupPrefix(prefix string) (string, bool)

+ func (r *Reader) Mode() Mode

+ func (r *Reader) Next() bool

+ func (r *Reader) ReadText(dst []byte, limit int) (b []byte, truncated bool)

+ func (r *Reader) Scripting() bool

+ func (r *Reader) SetChunkSize(n int)

+ func (r *Reader) SetKeepAttrs(v bool)

+ func (r *Reader) SetMaxDepth(n int)

+ func (r *Reader) SetMaxStackBytes(n int)

+ func (r *Reader) SetMaxTokenSize(n int)

+ func (r *Reader) SetMode(m Mode)

+ func (r *Reader) SetScripting(v bool)

+ func (r *Reader) SetStrict(v bool)

+ func (r *Reader) SetXMLSyntax(v bool)

+ func (r *Reader) Skip() error

+ func (r *Reader) Stack() iter.Seq[Element]

+ func (r *Reader) Token() *Token

+ type SyntaxError struct

+ Msg string

+ Pos Pos

+ func (e *SyntaxError) Error() string

+ type Token struct

+ func (t *Token) AppendLocalName(dst []byte) []byte

+ func (t *Token) AppendText(dst []byte) []byte

+ func (t *Token) Attr(name string) (Attr, bool)

+ func (t *Token) AttrAt(i int) Attr

+ func (t *Token) AttrNS(ns, local string) (Attr, bool)

+ func (t *Token) AttrNamespace(a Attr) string

+ func (t *Token) Attrs() iter.Seq[Attr]

+ func (t *Token) Bogus() bool

+ func (t *Token) Clone() *Token

+ func (t *Token) Continued() bool

+ func (t *Token) Data() []byte

+ func (t *Token) HTMLRules() bool

+ func (t *Token) HasAttr(name string) bool

+ func (t *Token) Implied() bool

+ func (t *Token) InRawText() bool

+ func (t *Token) Incomplete() bool

+ func (t *Token) Is(name string) bool

+ func (t *Token) Kind() Kind

+ func (t *Token) Local() []byte

+ func (t *Token) LocalIs(name string) bool

+ func (t *Token) NS() string

+ func (t *Token) Name() []byte

+ func (t *Token) NumAttrs() int

+ func (t *Token) Opens() bool

+ func (t *Token) Partial() bool

+ func (t *Token) Pos() Pos

+ func (t *Token) Prefix() []byte

+ func (t *Token) Raw() []byte

+ func (t *Token) SelfClosing() bool

+ func (t *Token) StartPos() Pos

+ func (t *Token) Stray() bool

+ func (t *Token) String() string

+ func (t *Token) Unsound() bool

+ func (t *Token) UnsoundError() error

+ func (t *Token) Untracked() bool

+ type TokenBuffer struct

+ func (b *TokenBuffer) All() iter.Seq[*Token]

+ func (b *TokenBuffer) Append(t *Token)

+ func (b *TokenBuffer) At(i int) *Token

+ func (b *TokenBuffer) Len() int

+ func (b *TokenBuffer) Reset()

+ func (b *TokenBuffer) Size() int

+ type Transformer struct

+ func NewTransformer(w io.Writer, r io.Reader) *Transformer

+ func (t *Transformer) All() iter.Seq[*Token]

+ func (t *Transformer) Children() iter.Seq[*Token]

+ func (t *Transformer) Close() error

+ func (t *Transformer) Depth() int

+ func (t *Transformer) EffectiveMode() Mode

+ func (t *Transformer) Empty() error

+ func (t *Transformer) Err() error

+ func (t *Transformer) ExpandSelfClosing() error

+ func (t *Transformer) Find(m Matcher) bool

+ func (t *Transformer) Held(h Hold) []byte

+ func (t *Transformer) Hold() (Hold, error)

+ func (t *Transformer) HoldDiscard(h Hold, raw []byte) error

+ func (t *Transformer) HoldRelease(h Hold) error

+ func (t *Transformer) Holding() int

+ func (t *Transformer) InsertAfter(raw []byte) error

+ func (t *Transformer) InsertAtEnd(raw []byte)

+ func (t *Transformer) InsertBefore(raw []byte) error

+ func (t *Transformer) LookupPrefix(prefix string) (string, bool)

+ func (t *Transformer) Mode() Mode

+ func (t *Transformer) Next() bool

+ func (t *Transformer) ReadText(dst []byte, limit int) ([]byte, bool)

+ func (t *Transformer) Reader() *Reader

+ func (t *Transformer) Remove() error

+ func (t *Transformer) RemoveAttr(name string) error

+ func (t *Transformer) RemoveAttrs(fn func(Attr) bool) error

+ func (t *Transformer) Rename(name string) error

+ func (t *Transformer) RenameAttr(name, newName string) error

+ func (t *Transformer) RenameEnd(name string) error

+ func (t *Transformer) Replace(raw []byte) error

+ func (t *Transformer) Scripting() bool

+ func (t *Transformer) SetAttr(name, value string) error

+ func (t *Transformer) SetAttrAt(name, value string, at int) error

+ func (t *Transformer) SetChunkSize(n int)

+ func (t *Transformer) SetKeepAttrs(v bool)

+ func (t *Transformer) SetMaxDepth(n int)

+ func (t *Transformer) SetMaxHold(n int)

+ func (t *Transformer) SetMaxStackBytes(n int)

+ func (t *Transformer) SetMaxTokenSize(n int)

+ func (t *Transformer) SetMode(m Mode)

+ func (t *Transformer) SetScripting(v bool)

+ func (t *Transformer) SetStrict(v bool)

+ func (t *Transformer) SetXMLSyntax(v bool)

+ func (t *Transformer) Skip() error

+ func (t *Transformer) Stack() iter.Seq[Element]

+ func (t *Transformer) Token() *Token

+ func (t *Transformer) Unwrap() error

+ func (t *Transformer) Wrap(start, end []byte) error