Data.EBird.API.Hotspots

Types and functions related to eBird hotspot API values.

Hotspot type

data Hotspot

eBird hotspots, as returned by the RegionHotspotsAPI

Constructors

Hotspot

Fields

• _hotspotLocationId :: Text

  Location ID of the hotspot

• _hotspotLocationName :: Text

  Name of the hotspot

• _hotspotCountryCode :: Region

  The country the hotspot is in

• _hotspotSubnational1Code :: Region

  The state the hotspot is in

• _hotspotSubnational2Code :: Region

  The county the hotspot is in

• _hotspotLatitude :: Double

  The latitude of the hotspot

• _hotspotLongitude :: Double

  The longitude of the hotspot

• _hotspotLatestObsDateTime :: Maybe EBirdDateTime

  The date and time of the latest observation at the hotspot. Could be Nothing if the hotspot has never been birded

• _hotspotNumSpeciesAllTime :: Maybe Integer

  The number of species ever seen at the hotspot. Could be Nothing if the hotspot has never been birded

Instances

Read Hotspot

Defined in Data.EBird.API.Hotspots

Methods

readsPrec :: Int -> ReadS Hotspot

readList :: ReadS [Hotspot]

readPrec :: ReadPrec Hotspot

readListPrec :: ReadPrec [Hotspot]

Show Hotspot

Defined in Data.EBird.API.Hotspots

Methods

showsPrec :: Int -> Hotspot -> ShowS

show :: Hotspot -> String

showList :: [Hotspot] -> ShowS

Eq Hotspot

Defined in Data.EBird.API.Hotspots

Methods

(==) :: Hotspot -> Hotspot -> Bool

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

FromJSON Hotspot

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Hotspots

Methods

parseJSON :: Value -> Parser Hotspot

parseJSONList :: Value -> Parser [Hotspot]

ToJSON Hotspot

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Hotspots

Methods

toJSON :: Hotspot -> Value

toEncoding :: Hotspot -> Encoding

toJSONList :: [Hotspot] -> Value

toEncodingList :: [Hotspot] -> Encoding

(k ~ A_Lens, a ~ Region, b ~ Region) => LabelOptic "countryCode" k Hotspot Hotspot a b

Defined in Data.EBird.API.Hotspots

Methods

labelOptic :: Optic k NoIx Hotspot Hotspot a b

(k ~ A_Lens, a ~ Maybe EBirdDateTime, b ~ Maybe EBirdDateTime) => LabelOptic "latestObsDateTime" k Hotspot Hotspot a b

Defined in Data.EBird.API.Hotspots

Methods

labelOptic :: Optic k NoIx Hotspot Hotspot a b

(k ~ A_Lens, a ~ Double, b ~ Double) => LabelOptic "latitude" k Hotspot Hotspot a b

Defined in Data.EBird.API.Hotspots

Methods

labelOptic :: Optic k NoIx Hotspot Hotspot a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "locationId" k Hotspot Hotspot a b

Defined in Data.EBird.API.Hotspots

Methods

labelOptic :: Optic k NoIx Hotspot Hotspot a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "locationName" k Hotspot Hotspot a b

Defined in Data.EBird.API.Hotspots

Methods

labelOptic :: Optic k NoIx Hotspot Hotspot a b

(k ~ A_Lens, a ~ Double, b ~ Double) => LabelOptic "longitude" k Hotspot Hotspot a b

Defined in Data.EBird.API.Hotspots

Methods

labelOptic :: Optic k NoIx Hotspot Hotspot a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "numSpeciesAllTime" k Hotspot Hotspot a b

Defined in Data.EBird.API.Hotspots

Methods

labelOptic :: Optic k NoIx Hotspot Hotspot a b

(k ~ A_Lens, a ~ Region, b ~ Region) => LabelOptic "subnational1Code" k Hotspot Hotspot a b

Defined in Data.EBird.API.Hotspots

Methods

labelOptic :: Optic k NoIx Hotspot Hotspot a b

(k ~ A_Lens, a ~ Region, b ~ Region) => LabelOptic "subnational2Code" k Hotspot Hotspot a b

Defined in Data.EBird.API.Hotspots

Methods

labelOptic :: Optic k NoIx Hotspot Hotspot a b

Optics for the Hotspot type

hotspotSubnational2Code :: Lens' Hotspot Region

hotspotSubnational1Code :: Lens' Hotspot Region

hotspotNumSpeciesAllTime :: Lens' Hotspot (Maybe Integer)

hotspotLongitude :: Lens' Hotspot Double

hotspotLocationName :: Lens' Hotspot Text

hotspotLocationId :: Lens' Hotspot Text

hotspotLatitude :: Lens' Hotspot Double

hotspotLatestObsDateTime :: Lens' Hotspot (Maybe EBirdDateTime)

hotspotCountryCode :: Lens' Hotspot Region

Auxiliary eBird hotspot-related API types

data CSVOrJSONFormat

Used to specify what format hotspot values should be returned in from the hotspots APIs.

Constructors

CSVFormat

JSONFormat

Instances

IsString CSVOrJSONFormat

Use this instance carefully! It throws runtime exceptions if the string is malformatted.

Defined in Data.EBird.API.Hotspots

Methods

fromString :: String -> CSVOrJSONFormat

Read CSVOrJSONFormat

Defined in Data.EBird.API.Hotspots

Methods

readsPrec :: Int -> ReadS CSVOrJSONFormat

readList :: ReadS [CSVOrJSONFormat]

readPrec :: ReadPrec CSVOrJSONFormat

readListPrec :: ReadPrec [CSVOrJSONFormat]

Show CSVOrJSONFormat

Defined in Data.EBird.API.Hotspots

Methods

showsPrec :: Int -> CSVOrJSONFormat -> ShowS

show :: CSVOrJSONFormat -> String

showList :: [CSVOrJSONFormat] -> ShowS

EBirdString CSVOrJSONFormat

The eBird string of a CSVOrJSONFormat value is either "csv" or "json".

Defined in Data.EBird.API.Hotspots

Methods

toEBirdString :: CSVOrJSONFormat -> Text

fromEBirdString :: Text -> Either Text CSVOrJSONFormat

Eq CSVOrJSONFormat

Defined in Data.EBird.API.Hotspots

Methods

(==) :: CSVOrJSONFormat -> CSVOrJSONFormat -> Bool

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

ToHttpApiData CSVOrJSONFormat

Defined in Data.EBird.API.Hotspots

Methods

toUrlPiece :: CSVOrJSONFormat -> Text

toEncodedUrlPiece :: CSVOrJSONFormat -> Builder

toHeader :: CSVOrJSONFormat -> ByteString

toQueryParam :: CSVOrJSONFormat -> Text

toEncodedQueryParam :: CSVOrJSONFormat -> Builder

attoparsec parsers

parseCSVOrJSONFormat :: Parser CSVOrJSONFormat

Parse a list of eBird API taxononomy categories. To avoid the partial behavior of converting a sepBy1 result into a NonEmpty, we manually parse the first category followed by an optional tail.