package dnsmessage

Import Path
	vendor/golang.org/x/net/dns/dnsmessage (on golang.org and go.dev)

Dependency Relation
	imports one package, and imported by one package

Involved Source Files
	d-> message.go

Exported Type Names

	 type AAAAResource (struct)
		An AAAAResource is an AAAA Resource record.

		One Exported Field
			AAAA [16]byte
		One Exported Method
			(*T) GoString() string
		Implements (2+)
			*T : ResourceBody
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).AAAAResource() (AAAAResource, error)
		As Inputs Of (1+)
			func (*Builder).AAAAResource(h ResourceHeader, r AAAAResource) error
	 type AResource (struct)
		An AResource is an A Resource record.

		One Exported Field
			A [4]byte
		One Exported Method
			(*T) GoString() string
		Implements (2+)
			*T : ResourceBody
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).AResource() (AResource, error)
		As Inputs Of (1+)
			func (*Builder).AResource(h ResourceHeader, r AResource) error
	 type Builder (struct)
		A Builder allows incrementally packing a DNS message.

		Example usage:
			buf := make([]byte, 2, 514)
			b := NewBuilder(buf, Header{...})
			b.EnableCompression()
			// Optionally start a section and add things to that section.
			// Repeat adding sections as necessary.
			buf, err := b.Finish()
			// If err is nil, buf[2:] will contain the built bytes.

		Exported Methods (17)
			(*T) AAAAResource(h ResourceHeader, r AAAAResource) error
			(*T) AResource(h ResourceHeader, r AResource) error
			(*T) CNAMEResource(h ResourceHeader, r CNAMEResource) error
			(*T) EnableCompression()
			(*T) Finish() ([]byte, error)
			(*T) MXResource(h ResourceHeader, r MXResource) error
			(*T) NSResource(h ResourceHeader, r NSResource) error
			(*T) OPTResource(h ResourceHeader, r OPTResource) error
			(*T) PTRResource(h ResourceHeader, r PTRResource) error
			(*T) Question(q Question) error
			(*T) SOAResource(h ResourceHeader, r SOAResource) error
			(*T) SRVResource(h ResourceHeader, r SRVResource) error
			(*T) StartAdditionals() error
			(*T) StartAnswers() error
			(*T) StartAuthorities() error
			(*T) StartQuestions() error
			(*T) TXTResource(h ResourceHeader, r TXTResource) error
		As Outputs Of (1+)
			func NewBuilder(buf []byte, h Header) Builder
	 type Class uint16
		A Class is a type of network.

		Exported Methods (2)
			 (T) GoString() string
			 (T) String() string
		Implements (2+)
			 T : fmt.GoStringer
			 T : fmt.Stringer
		As Types Of (5+)
			const ClassANY
			const ClassCHAOS
			const ClassCSNET
			const ClassHESIOD
			const ClassINET
	 type CNAMEResource (struct)
		A CNAMEResource is a CNAME Resource record.

		One Exported Field
			CNAME Name
		One Exported Method
			(*T) GoString() string
		Implements (2+)
			*T : ResourceBody
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).CNAMEResource() (CNAMEResource, error)
		As Inputs Of (1+)
			func (*Builder).CNAMEResource(h ResourceHeader, r CNAMEResource) error
	 type Header (struct)
		Header is a representation of a DNS message header.

		Exported Fields (8)
			Authoritative bool
			ID uint16
			OpCode OpCode
			RCode RCode
			RecursionAvailable bool
			RecursionDesired bool
			Response bool
			Truncated bool
		One Exported Method
			(*T) GoString() string
		Implements (1+)
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).Start(msg []byte) (Header, error)
		As Inputs Of (1+)
			func NewBuilder(buf []byte, h Header) Builder
	 type Message (struct)
		Message is a representation of a DNS message.

		Exported Fields (13)
			Additionals []Resource
			Answers []Resource
			Authorities []Resource
			Header Header
			Header.Authoritative bool
			Header.ID uint16
			Header.OpCode OpCode
			Header.RCode RCode
			Header.RecursionAvailable bool
			Header.RecursionDesired bool
			Header.Response bool
			Header.Truncated bool
			Questions []Question
		Exported Methods (4)
			(*T) AppendPack(b []byte) ([]byte, error)
			(*T) GoString() string
			(*T) Pack() ([]byte, error)
			(*T) Unpack(msg []byte) error
		Implements (1+)
			*T : fmt.GoStringer
	 type MXResource (struct)
		An MXResource is an MX Resource record.

		Exported Fields (2)
			MX Name
			Pref uint16
		One Exported Method
			(*T) GoString() string
		Implements (2+)
			*T : ResourceBody
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).MXResource() (MXResource, error)
		As Inputs Of (1+)
			func (*Builder).MXResource(h ResourceHeader, r MXResource) error
	 type Name (struct)
		A Name is a non-encoded domain name. It is used instead of strings to avoid
		allocations.

		Exported Fields (2)
			Data [255]byte
			Length uint8
		Exported Methods (2)
			(*T) GoString() string
			 (T) String() string
		Implements (2+)
			*T : fmt.GoStringer
			 T : fmt.Stringer
		As Outputs Of (2+)
			func MustNewName(name string) Name
			func NewName(name string) (Name, error)
	 type NSResource (struct)
		An NSResource is an NS Resource record.

		One Exported Field
			NS Name
		One Exported Method
			(*T) GoString() string
		Implements (2+)
			*T : ResourceBody
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).NSResource() (NSResource, error)
		As Inputs Of (1+)
			func (*Builder).NSResource(h ResourceHeader, r NSResource) error
	 type OpCode uint16
		An OpCode is a DNS operation code.

		One Exported Method
			 (T) GoString() string
		Implements (1+)
			 T : fmt.GoStringer
	 type Option (struct)
		An Option represents a DNS message option within OPTResource.

		The message option is part of the extension mechanisms for DNS as
		defined in RFC 6891.

		Exported Fields (2)
			Code uint16
			Data []byte
		One Exported Method
			(*T) GoString() string
		Implements (1+)
			*T : fmt.GoStringer
	 type OPTResource (struct)
		An OPTResource is an OPT pseudo Resource record.

		The pseudo resource record is part of the extension mechanisms for DNS
		as defined in RFC 6891.

		One Exported Field
			Options []Option
		One Exported Method
			(*T) GoString() string
		Implements (2+)
			*T : ResourceBody
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).OPTResource() (OPTResource, error)
		As Inputs Of (1+)
			func (*Builder).OPTResource(h ResourceHeader, r OPTResource) error
	 type Parser (struct)
		A Parser allows incrementally parsing a DNS message.

		When parsing is started, the Header is parsed. Next, each Question can be
		either parsed or skipped. Alternatively, all Questions can be skipped at
		once. When all Questions have been parsed, attempting to parse Questions
		will return (nil, nil) and attempting to skip Questions will return
		(true, nil). After all Questions have been either parsed or skipped, all
		Answers, Authorities and Additionals can be either parsed or skipped in the
		same way, and each type of Resource must be fully parsed or skipped before
		proceeding to the next type of Resource.

		Note that there is no requirement to fully skip or parse the message.

		Exported Methods (30)
			(*T) AAAAResource() (AAAAResource, error)
			(*T) AResource() (AResource, error)
			(*T) Additional() (Resource, error)
			(*T) AdditionalHeader() (ResourceHeader, error)
			(*T) AllAdditionals() ([]Resource, error)
			(*T) AllAnswers() ([]Resource, error)
			(*T) AllAuthorities() ([]Resource, error)
			(*T) AllQuestions() ([]Question, error)
			(*T) Answer() (Resource, error)
			(*T) AnswerHeader() (ResourceHeader, error)
			(*T) Authority() (Resource, error)
			(*T) AuthorityHeader() (ResourceHeader, error)
			(*T) CNAMEResource() (CNAMEResource, error)
			(*T) MXResource() (MXResource, error)
			(*T) NSResource() (NSResource, error)
			(*T) OPTResource() (OPTResource, error)
			(*T) PTRResource() (PTRResource, error)
			(*T) Question() (Question, error)
			(*T) SOAResource() (SOAResource, error)
			(*T) SRVResource() (SRVResource, error)
			(*T) SkipAdditional() error
			(*T) SkipAllAdditionals() error
			(*T) SkipAllAnswers() error
			(*T) SkipAllAuthorities() error
			(*T) SkipAllQuestions() error
			(*T) SkipAnswer() error
			(*T) SkipAuthority() error
			(*T) SkipQuestion() error
			(*T) Start(msg []byte) (Header, error)
			(*T) TXTResource() (TXTResource, error)
	 type PTRResource (struct)
		A PTRResource is a PTR Resource record.

		One Exported Field
			PTR Name
		One Exported Method
			(*T) GoString() string
		Implements (2+)
			*T : ResourceBody
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).PTRResource() (PTRResource, error)
		As Inputs Of (1+)
			func (*Builder).PTRResource(h ResourceHeader, r PTRResource) error
	 type Question (struct)
		A Question is a DNS query.

		Exported Fields (3)
			Class Class
			Name Name
			Type Type
		One Exported Method
			(*T) GoString() string
		Implements (1+)
			*T : fmt.GoStringer
		As Outputs Of (2+)
			func (*Parser).AllQuestions() ([]Question, error)
			func (*Parser).Question() (Question, error)
		As Inputs Of (1+)
			func (*Builder).Question(q Question) error
	 type RCode uint16
		An RCode is a DNS response status code.

		Exported Methods (2)
			 (T) GoString() string
			 (T) String() string
		Implements (2+)
			 T : fmt.GoStringer
			 T : fmt.Stringer
		As Outputs Of (1+)
			func (*ResourceHeader).ExtendedRCode(rcode RCode) RCode
		As Inputs Of (2+)
			func (*ResourceHeader).ExtendedRCode(rcode RCode) RCode
			func (*ResourceHeader).SetEDNS0(udpPayloadLen int, extRCode RCode, dnssecOK bool) error
		As Types Of (6+)
			const RCodeFormatError
			const RCodeNameError
			const RCodeNotImplemented
			const RCodeRefused
			const RCodeServerFailure
			const RCodeSuccess
	 type Resource (struct)
		A Resource is a DNS resource record.

		Exported Fields (2)
			Body ResourceBody
			Header ResourceHeader
		One Exported Method
			(*T) GoString() string
		Implements (1+)
			*T : fmt.GoStringer
		As Outputs Of (6+)
			func (*Parser).Additional() (Resource, error)
			func (*Parser).AllAdditionals() ([]Resource, error)
			func (*Parser).AllAnswers() ([]Resource, error)
			func (*Parser).AllAuthorities() ([]Resource, error)
			func (*Parser).Answer() (Resource, error)
			func (*Parser).Authority() (Resource, error)
	 type ResourceBody (interface)
		A ResourceBody is a DNS resource record minus the header.

		One Exported Method
			 (T) GoString() string
		Implemented By (10+)
			*AAAAResource
			*AResource
			*CNAMEResource
			*MXResource
			*NSResource
			*OPTResource
			*PTRResource
			*SOAResource
			*SRVResource
			*TXTResource
		Implements (1+)
			 T : fmt.GoStringer
	 type ResourceHeader (struct)
		A ResourceHeader is the header of a DNS resource record. There are
		many types of DNS resource records, but they all share the same header.

		Exported Fields (5)
			Class Class
			Length uint16
			Name Name
			TTL uint32
			Type Type
		Exported Methods (4)
			(*T) DNSSECAllowed() bool
			(*T) ExtendedRCode(rcode RCode) RCode
			(*T) GoString() string
			(*T) SetEDNS0(udpPayloadLen int, extRCode RCode, dnssecOK bool) error
		Implements (1+)
			*T : fmt.GoStringer
		As Outputs Of (3+)
			func (*Parser).AdditionalHeader() (ResourceHeader, error)
			func (*Parser).AnswerHeader() (ResourceHeader, error)
			func (*Parser).AuthorityHeader() (ResourceHeader, error)
		As Inputs Of (10+)
			func (*Builder).AAAAResource(h ResourceHeader, r AAAAResource) error
			func (*Builder).AResource(h ResourceHeader, r AResource) error
			func (*Builder).CNAMEResource(h ResourceHeader, r CNAMEResource) error
			func (*Builder).MXResource(h ResourceHeader, r MXResource) error
			func (*Builder).NSResource(h ResourceHeader, r NSResource) error
			func (*Builder).OPTResource(h ResourceHeader, r OPTResource) error
			func (*Builder).PTRResource(h ResourceHeader, r PTRResource) error
			func (*Builder).SOAResource(h ResourceHeader, r SOAResource) error
			func (*Builder).SRVResource(h ResourceHeader, r SRVResource) error
			func (*Builder).TXTResource(h ResourceHeader, r TXTResource) error
	 type SOAResource (struct)
		An SOAResource is an SOA Resource record.

		Exported Fields (7)
			Expire uint32
			MBox Name
			MinTTL uint32
			NS Name
			Refresh uint32
			Retry uint32
			Serial uint32
		One Exported Method
			(*T) GoString() string
		Implements (2+)
			*T : ResourceBody
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).SOAResource() (SOAResource, error)
		As Inputs Of (1+)
			func (*Builder).SOAResource(h ResourceHeader, r SOAResource) error
	 type SRVResource (struct)
		An SRVResource is an SRV Resource record.

		Exported Fields (4)
			Port uint16
			Priority uint16
			Target Name
			Weight uint16
		One Exported Method
			(*T) GoString() string
		Implements (2+)
			*T : ResourceBody
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).SRVResource() (SRVResource, error)
		As Inputs Of (1+)
			func (*Builder).SRVResource(h ResourceHeader, r SRVResource) error
	 type TXTResource (struct)
		A TXTResource is a TXT Resource record.

		One Exported Field
			TXT []string
		One Exported Method
			(*T) GoString() string
		Implements (2+)
			*T : ResourceBody
			*T : fmt.GoStringer
		As Outputs Of (1+)
			func (*Parser).TXTResource() (TXTResource, error)
		As Inputs Of (1+)
			func (*Builder).TXTResource(h ResourceHeader, r TXTResource) error
	 type Type uint16
		A Type is a type of DNS request and response.

		Exported Methods (2)
			 (T) GoString() string
			 (T) String() string
		Implements (2+)
			 T : fmt.GoStringer
			 T : fmt.Stringer
		As Types Of (15+)
			const TypeA
			const TypeAAAA
			const TypeALL
			const TypeAXFR
			const TypeCNAME
			const TypeHINFO
			const TypeMINFO
			const TypeMX
			const TypeNS
			const TypeOPT
			const TypePTR
			const TypeSOA
			const TypeSRV
			const TypeTXT
			const TypeWKS
Exported Values

	const ClassANY Class = 255
		Question.Class
	const ClassCHAOS Class = 3
	const ClassCSNET Class = 2
	const ClassHESIOD Class = 4
	const ClassINET Class = 1
		ResourceHeader.Class and Question.Class
	  var ErrNotStarted error
		ErrNotStarted indicates that the prerequisite information isn't
		available yet because the previous records haven't been appropriately
		parsed, skipped or finished.
	  var ErrSectionDone error
		ErrSectionDone indicated that all records in the section have been
		parsed or finished.
	 func MustNewName(name string) Name
		MustNewName creates a new Name from a string and panics on error.
	 func NewBuilder(buf []byte, h Header) Builder
		NewBuilder creates a new builder with compression disabled.

		Note: Most users will want to immediately enable compression with the
		EnableCompression method. See that method's comment for why you may or may
		not want to enable compression.

		The DNS message is appended to the provided initial buffer buf (which may be
		nil) as it is built. The final message is returned by the (*Builder).Finish
		method, which may return the same underlying array if there was sufficient
		capacity in the slice.
	 func NewName(name string) (Name, error)
		NewName creates a new Name from a string.
	const RCodeFormatError RCode = 1
	const RCodeNameError RCode = 3
	const RCodeNotImplemented RCode = 4
	const RCodeRefused RCode = 5
	const RCodeServerFailure RCode = 2
	const RCodeSuccess RCode = 0
		Message.Rcode
	const TypeA Type = 1
		ResourceHeader.Type and Question.Type
	const TypeAAAA Type = 28
	const TypeALL Type = 255
	const TypeAXFR Type = 252
	const TypeCNAME Type = 5
	const TypeHINFO Type = 13
	const TypeMINFO Type = 14
	const TypeMX Type = 15
	const TypeNS Type = 2
	const TypeOPT Type = 41
	const TypePTR Type = 12
	const TypeSOA Type = 6
	const TypeSRV Type = 33
	const TypeTXT Type = 16
	const TypeWKS Type = 11
		Question.Type

The pages are generated with Golds v0.1.6. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project and developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.