package madns

Import Path
	github.com/multiformats/go-multiaddr-dns (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	    mock.go
	    resolve.go
	    util.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type BasicResolver (interface)
		BasicResolver is a low level interface for DNS resolution

		Methods (total 2)
			( BasicResolver) LookupIPAddr(context.Context, string) ([]net.IPAddr, error)
			( BasicResolver) LookupTXT(context.Context, string) ([]string, error)
		Implemented By (at least 4)
			*MockResolver
			*Resolver
			 github.com/libp2p/go-libp2p/p2p/net/swarm.ResolverFromMaDNS
			*net.Resolver
		As Inputs Of (at least 2)
			func WithDefaultResolver(def BasicResolver) Option
			func WithDomainResolver(domain string, rslv BasicResolver) Option

	 type MockResolver (struct)

		Fields (total 2)
			IP map[string][]net.IPAddr
			TXT map[string][]string
		Methods (total 2)
			(*MockResolver) LookupIPAddr(ctx context.Context, name string) ([]net.IPAddr, error)
			(*MockResolver) LookupTXT(ctx context.Context, name string) ([]string, error)
		Implements (at least one exported)
			*MockResolver : BasicResolver

	 type Option (func)

		As Outputs Of (at least 2)
			func WithDefaultResolver(def BasicResolver) Option
			func WithDomainResolver(domain string, rslv BasicResolver) Option
		As Inputs Of (at least one exported)
			func NewResolver(opts ...Option) (*Resolver, error)

	 type Resolver (struct)
		Resolver is an object capable of resolving dns multiaddrs by using one or more BasicResolvers;
		it supports custom per domain/TLD resolvers.
		It also implements the BasicResolver interface so that it can act as a custom per domain/TLD
		resolver.

		Methods (total 3)
			(*Resolver) LookupIPAddr(ctx context.Context, domain string) ([]net.IPAddr, error)
			(*Resolver) LookupTXT(ctx context.Context, txt string) ([]string, error)
			(*Resolver) Resolve(ctx context.Context, maddr ma.Multiaddr) ([]ma.Multiaddr, error)
				Resolve resolves a DNS multiaddr. It will only resolve the first DNS component in the multiaddr.
				If you need to resolve multiple DNS components, you may call this function again with each returned address.

		Implements (at least 2)
			*Resolver : BasicResolver
			*Resolver : github.com/libp2p/go-libp2p/core/transport.Resolver
		As Outputs Of (at least one exported)
			func NewResolver(opts ...Option) (*Resolver, error)
		As Types Of (only one)
			  var DefaultResolver *Resolver


Package-Level Functions (total 5)

	 func Matches(maddr ma.Multiaddr) (matches bool)
	 func NewResolver(opts ...Option) (*Resolver, error)
		NewResolver creates a new Resolver instance with the specified options

	 func Resolve(ctx context.Context, maddr ma.Multiaddr) ([]ma.Multiaddr, error)
	 func WithDefaultResolver(def BasicResolver) Option
		WithDefaultResolver is an option that specifies the default basic resolver,
		which resolves any TLD that doesn't have a custom resolver.
		Defaults to net.DefaultResolver

	 func WithDomainResolver(domain string, rslv BasicResolver) Option
		WithDomainResolver specifies a custom resolver for a domain/TLD.
		Custom resolver selection matches domains left to right, with more specific resolvers
		superseding generic ones.


Package-Level Variables (total 2)

	  var DefaultResolver *Resolver
	  var ResolvableProtocols []multiaddr.Protocol

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