Bluesky.Handle

Documentation

data Handle

https://atproto.com/specs/handle

Instances

Show Handle

Defined in Bluesky.Handle

Methods

showsPrec :: Int -> Handle -> ShowS

show :: Handle -> String

showList :: [Handle] -> ShowS

Eq Handle

Defined in Bluesky.Handle

Methods

(==) :: Handle -> Handle -> Bool

(/=) :: Handle -> Handle -> Bool

Ord Handle

Defined in Bluesky.Handle

Methods

compare :: Handle -> Handle -> Ordering

(<) :: Handle -> Handle -> Bool

(<=) :: Handle -> Handle -> Bool

(>) :: Handle -> Handle -> Bool

(>=) :: Handle -> Handle -> Bool

max :: Handle -> Handle -> Handle

min :: Handle -> Handle -> Handle

FromHttpApiData Handle

Defined in Bluesky.Handle

Methods

parseUrlPiece :: Text -> Either Text Handle

parseHeader :: ByteString -> Either Text Handle

parseQueryParam :: Text -> Either Text Handle

rawHandle :: Handle -> Text

makeHandle :: Text -> Either HandleError Handle

data HandleError

Constructors

TooLong

BadCharacters

EmptySegment

SegmentTooLong

SegmentStartsWithHyphen

SegmentEndsWithHyphen

OnlyOneSegment

LastSegmentStartsWithNumber

Instances

Show HandleError

Defined in Bluesky.Handle

Methods

showsPrec :: Int -> HandleError -> ShowS

show :: HandleError -> String

showList :: [HandleError] -> ShowS

Eq HandleError

Defined in Bluesky.Handle

Methods

(==) :: HandleError -> HandleError -> Bool

(/=) :: HandleError -> HandleError -> Bool

Ord HandleError

Defined in Bluesky.Handle

Methods

compare :: HandleError -> HandleError -> Ordering

(<) :: HandleError -> HandleError -> Bool

(<=) :: HandleError -> HandleError -> Bool

(>) :: HandleError -> HandleError -> Bool

(>=) :: HandleError -> HandleError -> Bool

max :: HandleError -> HandleError -> HandleError

min :: HandleError -> HandleError -> HandleError

validTld :: Handle -> Bool

See "Additonal Non-Syntax Restrictions" in the spec

resolveViaDns :: HasCallStack => Handle -> IO (Maybe Did)

Returns Nothing in ordinary cases where this handle can't be resolved by DNS. May raise an exception if either the handle has an invalid TLD or something goes wrong with DNS resolution.

Note that this handle shouldn't be considered valid for this DID until you've looked up the associated DID document and checked it appears there.

resolveViaHttp :: HasCallStack => Manager -> Handle -> IO (Maybe Did)

Returns Nothing when the expected hostname reports 404 for the HTTP resolution endpoint. May raise an exception if either the handle has an invalid TLD or there's no HTTP server at the expected domain at all.

Note that this handle shouldn't be considered valid for this DID until you've looked up the associated DID document and checked it appears there.

resolveViaBoth :: HasCallStack => Manager -> Handle -> IO (Maybe Did)

If either resolveViaDns or resolveViaHttp return a Did, return that Did. Otherwise, if one or both of them raised an exception, reraise it (or them, via BothFailed). (Otherwise, return Nothing).

data BothFailed

Raised by resolveViaBoth when both methods raise exceptions.

Constructors

BothFailed

Fields

• dnsException :: SomeException
• httpException :: SomeException

Instances

Exception BothFailed

Defined in Bluesky.Handle

Methods

toException :: BothFailed -> SomeException

fromException :: SomeException -> Maybe BothFailed

displayException :: BothFailed -> String

Show BothFailed

Defined in Bluesky.Handle

Methods

showsPrec :: Int -> BothFailed -> ShowS

show :: BothFailed -> String

showList :: [BothFailed] -> ShowS

resolveVerify :: HasCallStack => Manager -> Handle -> IO (Maybe Did)

Also fetches the DID document and checks that the handle is listed there. Raises an error if not.