Data.EBird.API.Regions

Types related to eBird region API values.

Region-related API types

data Region

eBird divides the world into countries, subnational1 regions (states) or subnational2 regions (counties). Location regions are eBird-specific location identifiers.

Constructors

Location Integer

Regions may be specified as location IDs, e.g. L227544

World

The world is a region

Country Text

At the top level, the world is divided into countries

Subnational1

Subnational1 regions are states within countries

Fields

• Text

  The country

• Text

  The state

Subnational2

Subnational2 regions are counties within states

Fields

• Text

  The country

• Text

  The state

• Text

  The county

Instances

IsString Region

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

Defined in Data.EBird.API.Regions

Methods

fromString :: String -> Region

Read Region

Defined in Data.EBird.API.Regions

Methods

readsPrec :: Int -> ReadS Region

readList :: ReadS [Region]

readPrec :: ReadPrec Region

readListPrec :: ReadPrec [Region]

Show Region

Defined in Data.EBird.API.Regions

Methods

showsPrec :: Int -> Region -> ShowS

show :: Region -> String

showList :: [Region] -> ShowS

EBirdString Region

A Region eBird string is either:

• "L227544" for location regions, where L227544 is the location ID.
• "world" for World regions.
• The country identifier (e.g. "US" for the United States) for Country regions.
• The country identifier and the state identifier separated by a hyphen for Subnational1 regions (e.g. "US-WY" for Wyoming in the United States).
• The county identifier, the state identifier, and the country identifier separated by hyphens for Subnational2 regions (e.g. US-WY-013)

Defined in Data.EBird.API.Regions

Methods

toEBirdString :: Region -> Text

fromEBirdString :: Text -> Either Text Region

Eq Region

Defined in Data.EBird.API.Regions

Methods

(==) :: Region -> Region -> Bool

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

ToHttpApiData Region

Defined in Data.EBird.API.Regions

Methods

toUrlPiece :: Region -> Text

toEncodedUrlPiece :: Region -> Builder

toHeader :: Region -> ByteString

toQueryParam :: Region -> Text

toEncodedQueryParam :: Region -> Builder

FromJSON Region

Defined in Data.EBird.API.Regions

Methods

parseJSON :: Value -> Parser Region

parseJSONList :: Value -> Parser [Region]

ToJSON Region

Defined in Data.EBird.API.Regions

Methods

toJSON :: Region -> Value

toEncoding :: Region -> Encoding

toJSONList :: [Region] -> Value

toEncodingList :: [Region] -> Encoding

k ~ A_Lens => LabelOptic "countryCode" k (ObservationDetails 'Full) (ObservationDetails 'Full) Region Region

Defined in Data.EBird.API.Observations

Methods

labelOptic :: Optic k NoIx (ObservationDetails 'Full) (ObservationDetails 'Full) Region Region

k ~ A_Lens => LabelOptic "subnational1Code" k (ObservationDetails 'Full) (ObservationDetails 'Full) Region Region

Defined in Data.EBird.API.Observations

Methods

labelOptic :: Optic k NoIx (ObservationDetails 'Full) (ObservationDetails 'Full) Region Region

k ~ A_Lens => LabelOptic "subnational2Code" k (ObservationDetails 'Full) (ObservationDetails 'Full) Region Region

Defined in Data.EBird.API.Observations

Methods

labelOptic :: Optic k NoIx (ObservationDetails 'Full) (ObservationDetails 'Full) Region Region

data RegionType

One constructor per eBird "region type" (countries, subnational1 (states), or subnational2 (counties)).

Constructors

CountryType

Subnational1Type

Subnational2Type

Instances

IsString RegionType

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

Defined in Data.EBird.API.Regions

Methods

fromString :: String -> RegionType

Read RegionType

Defined in Data.EBird.API.Regions

Methods

readsPrec :: Int -> ReadS RegionType

readList :: ReadS [RegionType]

readPrec :: ReadPrec RegionType

readListPrec :: ReadPrec [RegionType]

Show RegionType

Defined in Data.EBird.API.Regions

Methods

showsPrec :: Int -> RegionType -> ShowS

show :: RegionType -> String

showList :: [RegionType] -> ShowS

EBirdString RegionType

Results in eBird region type format

Defined in Data.EBird.API.Regions

Methods

toEBirdString :: RegionType -> Text

fromEBirdString :: Text -> Either Text RegionType

Eq RegionType

Defined in Data.EBird.API.Regions

Methods

(==) :: RegionType -> RegionType -> Bool

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

ToHttpApiData RegionType

Defined in Data.EBird.API.Regions

Methods

toUrlPiece :: RegionType -> Text

toEncodedUrlPiece :: RegionType -> Builder

toHeader :: RegionType -> ByteString

toQueryParam :: RegionType -> Text

toEncodedQueryParam :: RegionType -> Builder

newtype RegionCode

A RegionCode is a list of one or more Regions.

Constructors

RegionCode

Fields

• regionCodeRegions :: NonEmpty Region

Instances

IsString RegionCode

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

Defined in Data.EBird.API.Regions

Methods

fromString :: String -> RegionCode

Read RegionCode

Defined in Data.EBird.API.Regions

Methods

readsPrec :: Int -> ReadS RegionCode

readList :: ReadS [RegionCode]

readPrec :: ReadPrec RegionCode

readListPrec :: ReadPrec [RegionCode]

Show RegionCode

Defined in Data.EBird.API.Regions

Methods

showsPrec :: Int -> RegionCode -> ShowS

show :: RegionCode -> String

showList :: [RegionCode] -> ShowS

EBirdString RegionCode

A RegionCode eBird string is a comma-separated list of regions.

Defined in Data.EBird.API.Regions

Methods

toEBirdString :: RegionCode -> Text

fromEBirdString :: Text -> Either Text RegionCode

Eq RegionCode

Defined in Data.EBird.API.Regions

Methods

(==) :: RegionCode -> RegionCode -> Bool

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

ToHttpApiData RegionCode

Defined in Data.EBird.API.Regions

Methods

toUrlPiece :: RegionCode -> Text

toEncodedUrlPiece :: RegionCode -> Builder

toHeader :: RegionCode -> ByteString

toQueryParam :: RegionCode -> Text

toEncodedQueryParam :: RegionCode -> Builder

FromJSON RegionCode

Defined in Data.EBird.API.Regions

Methods

parseJSON :: Value -> Parser RegionCode

parseJSONList :: Value -> Parser [RegionCode]

ToJSON RegionCode

Defined in Data.EBird.API.Regions

Methods

toJSON :: RegionCode -> Value

toEncoding :: RegionCode -> Encoding

toJSONList :: [RegionCode] -> Value

toEncodingList :: [RegionCode] -> Encoding

data RegionNameFormat

RegionNameFormat values specify what format the API should return region names in. See the constructor docs for examples.

Constructors

DetailedNameFormat

DetailedNameFormat region name values are fully qualified with only the country abbreviated, e.g. "Madison County, New York, US"

DetailedNoQualNameFormat

DetailedNoQualNameFormat region name values are like DetailedNameFormat but without the country qualifier and no "county" annotation, e.g. "Madison, New York"

FullNameFormat

FullNameFormat region name values are fully qualified with no abbreviated country name and no "county" annotation, e.g. "Madison, New York, United States"

NameQualNameFormat

NameQualNameFormat region name values are just the annotated name, e.g. "Madison County"

NameOnlyNameFormat

NameOnlyNameFormat region name values are just the name, e.g. "Madison"

RevDetailedNameFormat

RevDetailedNameFormat region name values are like DetailedNameFormat but with reverse qualifiers, e.g. "US, New York, Madison County"

Instances

IsString RegionNameFormat

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

Defined in Data.EBird.API.Regions

Methods

fromString :: String -> RegionNameFormat

Read RegionNameFormat

Defined in Data.EBird.API.Regions

Methods

readsPrec :: Int -> ReadS RegionNameFormat

readList :: ReadS [RegionNameFormat]

readPrec :: ReadPrec RegionNameFormat

readListPrec :: ReadPrec [RegionNameFormat]

Show RegionNameFormat

Defined in Data.EBird.API.Regions

Methods

showsPrec :: Int -> RegionNameFormat -> ShowS

show :: RegionNameFormat -> String

showList :: [RegionNameFormat] -> ShowS

EBirdString RegionNameFormat

A RegionNameFormat is shown as the constructor name without the NameFormat suffix, in all lower-case.

Defined in Data.EBird.API.Regions

Methods

toEBirdString :: RegionNameFormat -> Text

fromEBirdString :: Text -> Either Text RegionNameFormat

Eq RegionNameFormat

Defined in Data.EBird.API.Regions

Methods

(==) :: RegionNameFormat -> RegionNameFormat -> Bool

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

ToHttpApiData RegionNameFormat

Defined in Data.EBird.API.Regions

Methods

toUrlPiece :: RegionNameFormat -> Text

toEncodedUrlPiece :: RegionNameFormat -> Builder

toHeader :: RegionNameFormat -> ByteString

toQueryParam :: RegionNameFormat -> Text

toEncodedQueryParam :: RegionNameFormat -> Builder

data RegionInfo

RegionInfo specifies the name of a region (in some RegionNameFormat) and the bounds of that region as RegionBounds.

Constructors

RegionInfo

Fields

• _regionInfoName :: Text
• _regionInfoBounds :: Maybe RegionBounds

Instances

Read RegionInfo

Defined in Data.EBird.API.Regions

Methods

readsPrec :: Int -> ReadS RegionInfo

readList :: ReadS [RegionInfo]

readPrec :: ReadPrec RegionInfo

readListPrec :: ReadPrec [RegionInfo]

Show RegionInfo

Defined in Data.EBird.API.Regions

Methods

showsPrec :: Int -> RegionInfo -> ShowS

show :: RegionInfo -> String

showList :: [RegionInfo] -> ShowS

Eq RegionInfo

Defined in Data.EBird.API.Regions

Methods

(==) :: RegionInfo -> RegionInfo -> Bool

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

FromJSON RegionInfo

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Regions

Methods

parseJSON :: Value -> Parser RegionInfo

parseJSONList :: Value -> Parser [RegionInfo]

ToJSON RegionInfo

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Regions

Methods

toJSON :: RegionInfo -> Value

toEncoding :: RegionInfo -> Encoding

toJSONList :: [RegionInfo] -> Value

toEncodingList :: [RegionInfo] -> Encoding

(k ~ A_Lens, a ~ Maybe RegionBounds, b ~ Maybe RegionBounds) => LabelOptic "bounds" k RegionInfo RegionInfo a b

Defined in Data.EBird.API.Regions

Methods

labelOptic :: Optic k NoIx RegionInfo RegionInfo a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k RegionInfo RegionInfo a b

Defined in Data.EBird.API.Regions

Methods

labelOptic :: Optic k NoIx RegionInfo RegionInfo a b

data RegionBounds

RegionBounds specify the corners of a bounding box around a region.

Constructors

RegionBounds

Fields

• _regionBoundsMinX :: Double
• _regionBoundsMaxX :: Double
• _regionBoundsMinY :: Double
• _regionBoundsMaxY :: Double

Instances

Read RegionBounds

Defined in Data.EBird.API.Regions

Methods

readsPrec :: Int -> ReadS RegionBounds

readList :: ReadS [RegionBounds]

readPrec :: ReadPrec RegionBounds

readListPrec :: ReadPrec [RegionBounds]

Show RegionBounds

Defined in Data.EBird.API.Regions

Methods

showsPrec :: Int -> RegionBounds -> ShowS

show :: RegionBounds -> String

showList :: [RegionBounds] -> ShowS

Eq RegionBounds

Defined in Data.EBird.API.Regions

Methods

(==) :: RegionBounds -> RegionBounds -> Bool

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

FromJSON RegionBounds

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Regions

Methods

parseJSON :: Value -> Parser RegionBounds

parseJSONList :: Value -> Parser [RegionBounds]

ToJSON RegionBounds

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Regions

Methods

toJSON :: RegionBounds -> Value

toEncoding :: RegionBounds -> Encoding

toJSONList :: [RegionBounds] -> Value

toEncodingList :: [RegionBounds] -> Encoding

(k ~ A_Lens, a ~ Double, b ~ Double) => LabelOptic "maxX" k RegionBounds RegionBounds a b

Defined in Data.EBird.API.Regions

Methods

labelOptic :: Optic k NoIx RegionBounds RegionBounds a b

(k ~ A_Lens, a ~ Double, b ~ Double) => LabelOptic "maxY" k RegionBounds RegionBounds a b

Defined in Data.EBird.API.Regions

Methods

labelOptic :: Optic k NoIx RegionBounds RegionBounds a b

(k ~ A_Lens, a ~ Double, b ~ Double) => LabelOptic "minX" k RegionBounds RegionBounds a b

Defined in Data.EBird.API.Regions

Methods

labelOptic :: Optic k NoIx RegionBounds RegionBounds a b

(k ~ A_Lens, a ~ Double, b ~ Double) => LabelOptic "minY" k RegionBounds RegionBounds a b

Defined in Data.EBird.API.Regions

Methods

labelOptic :: Optic k NoIx RegionBounds RegionBounds a b

data RegionListEntry

The data structure returned by the eBird SubregionListAPI and AdjacentRegionsAPI.

Constructors

RegionListEntry

Fields

• _regionListEntryRegion :: Region
• _regionListEntryName :: Text

Instances

Read RegionListEntry

Defined in Data.EBird.API.Regions

Methods

readsPrec :: Int -> ReadS RegionListEntry

readList :: ReadS [RegionListEntry]

readPrec :: ReadPrec RegionListEntry

readListPrec :: ReadPrec [RegionListEntry]

Show RegionListEntry

Defined in Data.EBird.API.Regions

Methods

showsPrec :: Int -> RegionListEntry -> ShowS

show :: RegionListEntry -> String

showList :: [RegionListEntry] -> ShowS

Eq RegionListEntry

Defined in Data.EBird.API.Regions

Methods

(==) :: RegionListEntry -> RegionListEntry -> Bool

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

FromJSON RegionListEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Regions

Methods

parseJSON :: Value -> Parser RegionListEntry

parseJSONList :: Value -> Parser [RegionListEntry]

ToJSON RegionListEntry

Explicit instance for compatibility with their field names

Defined in Data.EBird.API.Regions

Methods

toJSON :: RegionListEntry -> Value

toEncoding :: RegionListEntry -> Encoding

toJSONList :: [RegionListEntry] -> Value

toEncodingList :: [RegionListEntry] -> Encoding

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k RegionListEntry RegionListEntry a b

Defined in Data.EBird.API.Regions

Methods

labelOptic :: Optic k NoIx RegionListEntry RegionListEntry a b

(k ~ A_Lens, a ~ Region, b ~ Region) => LabelOptic "region" k RegionListEntry RegionListEntry a b

Defined in Data.EBird.API.Regions

Methods

labelOptic :: Optic k NoIx RegionListEntry RegionListEntry a b

Optics for region-related API types

regionInfoName :: Lens' RegionInfo Text

regionInfoBounds :: Lens' RegionInfo (Maybe RegionBounds)

regionBoundsMinY :: Lens' RegionBounds Double

regionBoundsMinX :: Lens' RegionBounds Double

regionBoundsMaxY :: Lens' RegionBounds Double

regionBoundsMaxX :: Lens' RegionBounds Double

regionListEntryRegion :: Lens' RegionListEntry Region

regionListEntryName :: Lens' RegionListEntry Text

attoparsec parsers

parseRegionCode :: Parser RegionCode

Parse an eBird API region code, which is a comma-separated list of one or more regions. To avoid the partial behavior of converting a sepBy1 result into a NonEmpty, we manually parse the first region followed by an optional tail.

parseRegion :: Parser Region

Parse an eBird API region. This parser only ensures that the input is somewhat well-formed, in that it is either:

• A Location region (an 'L' followed by an integral number)
• The World region (just the string "world")
• A Subnational2 region (formatted as "LETTERS-LETTERS-NUMBER" where LETTERS is one or more letters in any case, and NUMBERS is an integral number)
• A Subnational1 region (formatterd as "LETTERS-LETTERS")
• A Country region (just "LETTERS")

parseRegionNameFormat :: Parser RegionNameFormat

Parse an eBird API RegionNameFormat.

parseRegionType :: Parser RegionType

Parse an eBird API RegionType.