dnsbase
Copyright(c) Viktor Dukhovni 2026
LicenseBSD-3-Clause
Maintainerietf-dane@dukhovni.org
Stabilityunstable
Safe HaskellNone
LanguageGHC2024

Net.DNSBase.Error

Description

DNSError is the sum type returned by all failed lookups in Net.DNSBase.Lookup. Its constructors split by source: network problems (NetworkError), protocol-level decode or response-code failures (ProtocolError), API misuse errors (UserError), and so on. Information about the context in which the error occured is included when available. EncodeErr is the analogous sum returned by failures of the wire-form encoder.

Synopsis

Documentation

data DNSError Source #

DNS API errors.

Constructors

BadConfiguration String

Resolver misconfiguration.

BadNameserver IOException

Nameserver name -> address lookup failure.

DecodeError DecodeContext String

Error while decoding from wire form.

EncodeError EncodeContext

Error while encoding to wire form.

InvalidDomain String

Invalid domain name presentation form.

NetworkError NetworkContext

Error in connection establishment, data transmission or a timeout.

ProtocolError ProtocolContext

Unexpected DNS message.

ResponseError RCODE

DNS message indicates a remote error condition.

UserError UserContext

Invalid request.

Instances

Instances details
Exception DNSError Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

toException :: DNSError -> SomeException #

fromException :: SomeException -> Maybe DNSError #

displayException :: DNSError -> String #

backtraceDesired :: DNSError -> Bool #

Show DNSError Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

showsPrec :: Int -> DNSError -> ShowS #

show :: DNSError -> String #

showList :: [DNSError] -> ShowS #

Eq DNSError Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

(==) :: DNSError -> DNSError -> Bool #

(/=) :: DNSError -> DNSError -> Bool #

data DnsXprt where Source #

Transport between DNS client and server

Bundled Patterns

pattern DnsOverQUIC :: DnsXprt 
pattern DnsOverTCP :: DnsXprt 
pattern DnsOverTLS :: DnsXprt 
pattern DnsOverUDP :: DnsXprt 

Instances

Instances details
Presentable DnsXprt Source # 
Instance details

Defined in Net.DNSBase.Internal.Peer

Methods

present :: DnsXprt -> Builder -> Builder Source #

presentLazy :: DnsXprt -> ByteString -> ByteString Source #

Bounded DnsXprt Source # 
Instance details

Defined in Net.DNSBase.Internal.Peer

Methods

minBound :: DnsXprt #

maxBound :: DnsXprt #

Enum DnsXprt Source # 
Instance details

Defined in Net.DNSBase.Internal.Peer

Methods

succ :: DnsXprt -> DnsXprt #

pred :: DnsXprt -> DnsXprt #

toEnum :: Int -> DnsXprt #

fromEnum :: DnsXprt -> Int #

enumFrom :: DnsXprt -> [DnsXprt] #

enumFromThen :: DnsXprt -> DnsXprt -> [DnsXprt] #

enumFromTo :: DnsXprt -> DnsXprt -> [DnsXprt] #

enumFromThenTo :: DnsXprt -> DnsXprt -> DnsXprt -> [DnsXprt] #

Num DnsXprt Source # 
Instance details

Defined in Net.DNSBase.Internal.Peer

Methods

(+) :: DnsXprt -> DnsXprt -> DnsXprt #

(-) :: DnsXprt -> DnsXprt -> DnsXprt #

(*) :: DnsXprt -> DnsXprt -> DnsXprt #

negate :: DnsXprt -> DnsXprt #

abs :: DnsXprt -> DnsXprt #

signum :: DnsXprt -> DnsXprt #

fromInteger :: Integer -> DnsXprt #

Integral DnsXprt Source # 
Instance details

Defined in Net.DNSBase.Internal.Peer

Methods

quot :: DnsXprt -> DnsXprt -> DnsXprt #

rem :: DnsXprt -> DnsXprt -> DnsXprt #

div :: DnsXprt -> DnsXprt -> DnsXprt #

mod :: DnsXprt -> DnsXprt -> DnsXprt #

quotRem :: DnsXprt -> DnsXprt -> (DnsXprt, DnsXprt) #

divMod :: DnsXprt -> DnsXprt -> (DnsXprt, DnsXprt) #

toInteger :: DnsXprt -> Integer #

Real DnsXprt Source # 
Instance details

Defined in Net.DNSBase.Internal.Peer

Methods

toRational :: DnsXprt -> Rational #

Eq DnsXprt Source # 
Instance details

Defined in Net.DNSBase.Internal.Peer

Methods

(==) :: DnsXprt -> DnsXprt -> Bool #

(/=) :: DnsXprt -> DnsXprt -> Bool #

Ord DnsXprt Source # 
Instance details

Defined in Net.DNSBase.Internal.Peer

Methods

compare :: DnsXprt -> DnsXprt -> Ordering #

(<) :: DnsXprt -> DnsXprt -> Bool #

(<=) :: DnsXprt -> DnsXprt -> Bool #

(>) :: DnsXprt -> DnsXprt -> Bool #

(>=) :: DnsXprt -> DnsXprt -> Bool #

max :: DnsXprt -> DnsXprt -> DnsXprt #

min :: DnsXprt -> DnsXprt -> DnsXprt #

data EncodeErr r where Source #

Encoding error, polymorphic over the context type

Constructors

EncodeTooLong :: forall r. (Typeable r, Show r, Eq r) => r -> EncodeErr r

message or field too long

CantEncode :: forall r. (Typeable r, Show r, Eq r) => r -> EncodeErr r

Invalid input

ReservedType :: forall r. (Typeable r, Show r, Eq r) => RRTYPE -> r -> EncodeErr r

Unencodable reserved type

EDNSRequired :: forall r. EncodeErr r

RCODE or flags require EDNS

Instances

Instances details
Show r => Show (EncodeErr r) Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

showsPrec :: Int -> EncodeErr r -> ShowS #

show :: EncodeErr r -> String #

showList :: [EncodeErr r] -> ShowS #

Eq r => Eq (EncodeErr r) Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

(==) :: EncodeErr r -> EncodeErr r -> Bool #

(/=) :: EncodeErr r -> EncodeErr r -> Bool #

data NetworkContext Source #

Constructors

RetryLimitExceeded

The number of retries for the request was exceeded.

TimeoutExpired

TCP fallback request timed out.

NetworkFailure IOException

Network failure.

ServerFailure 

Instances

Instances details
Show NetworkContext Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

showsPrec :: Int -> NetworkContext -> ShowS #

show :: NetworkContext -> String #

showList :: [NetworkContext] -> ShowS #

Eq NetworkContext Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

(==) :: NetworkContext -> NetworkContext -> Bool #

(/=) :: NetworkContext -> NetworkContext -> Bool #

data ProtocolContext Source #

Constructors

SequenceNumberMismatch

The question section of the response doesn't match our query. This could indicate foul play.

QuestionMismatch 

Instances

Instances details
Show ProtocolContext Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

showsPrec :: Int -> ProtocolContext -> ShowS #

show :: ProtocolContext -> String #

showList :: [ProtocolContext] -> ShowS #

Eq ProtocolContext Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

(==) :: ProtocolContext -> ProtocolContext -> Bool #

(/=) :: ProtocolContext -> ProtocolContext -> Bool #

data UserContext Source #

Constructors

InvalidQueryType RRTYPE

The RRTYPE requested is invalid for queries.

IllegalDomain String

The domain for query is illegal.

BadResponseQuestionCount Int

The response message question count is not equal to 1.

Instances

Instances details
Show UserContext Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

showsPrec :: Int -> UserContext -> ShowS #

show :: UserContext -> String #

showList :: [UserContext] -> ShowS #

Eq UserContext Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

(==) :: UserContext -> UserContext -> Bool #

(/=) :: UserContext -> UserContext -> Bool #

data DecodeContext Source #

Request or response context in which a failure occurred. The decodeTriple holds the name, class and type of the problem RR, provided the error was not in one of those fields.

Constructors

DecodeContext 

Fields

Instances

Instances details
Presentable DecodeContext Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

present :: DecodeContext -> Builder -> Builder Source #

presentLazy :: DecodeContext -> ByteString -> ByteString Source #

Eq DecodeContext Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

(==) :: DecodeContext -> DecodeContext -> Bool #

(/=) :: DecodeContext -> DecodeContext -> Bool #

data EncodeContext Source #

Constructors

(Typeable r, Show r, Eq r) => EncodeContext (EncodeErr r) 

Instances

Instances details
Show EncodeContext Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

showsPrec :: Int -> EncodeContext -> ShowS #

show :: EncodeContext -> String #

showList :: [EncodeContext] -> ShowS #

Eq EncodeContext Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

(==) :: EncodeContext -> EncodeContext -> Bool #

(/=) :: EncodeContext -> EncodeContext -> Bool #

data DnsSection Source #

Message section for error reporting. The message header and EDNS OPT record are also considered sections in this context.

Constructors

DnsHeaderSection

While parsing the message header.

DnsQuestionSection

While parsing the question section.

DnsAnswerSection

While parsing the answer section.

DnsAuthoritySection

While parsing the authority section.

DnsAdditionalSection

While parsing the additional section.

DnsEDNSSection

While parsing the EDNS OPT record.

DnsNonSection

While parsing a wire-form message fragment.

Instances

Instances details
Presentable DnsSection Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

present :: DnsSection -> Builder -> Builder Source #

presentLazy :: DnsSection -> ByteString -> ByteString Source #

Show DnsSection Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

showsPrec :: Int -> DnsSection -> ShowS #

show :: DnsSection -> String #

showList :: [DnsSection] -> ShowS #

Eq DnsSection Source # 
Instance details

Defined in Net.DNSBase.Internal.Error

Methods

(==) :: DnsSection -> DnsSection -> Bool #

(/=) :: DnsSection -> DnsSection -> Bool #

data MessageSource Source #

DNS client or server peer endpoint.

Constructors

MessageSource 

Fields

Instances

Instances details
Presentable MessageSource Source # 
Instance details

Defined in Net.DNSBase.Internal.Peer

Methods

present :: MessageSource -> Builder -> Builder Source #

presentLazy :: MessageSource -> ByteString -> ByteString Source #

Eq MessageSource Source # 
Instance details

Defined in Net.DNSBase.Internal.Peer

Methods

(==) :: MessageSource -> MessageSource -> Bool #

(/=) :: MessageSource -> MessageSource -> Bool #