search

kordlib / kord

Idiomatic Kotlin Wrapper for The Discord API
MIT License
909 stars 80 forks source link

Sealed base type for Kord events #904

Open gdude2002 opened 8 months ago

gdude2002 commented 8 months ago

Currently, Kord events all extend the Event interface, which is open. This is good - it means that frameworks can combine their events with Kord's in their event handling systems trivially.

However, this also creates a problem - when using a when for type checking event objects, the compiler/IDE will be unable to generate an exhaustive list of conditionals. In the case of KordEx, which has functions like this to extract data from Kord events, this means it's very difficult for me to know about changes to Kord's event line up.

To fix this, I propose adding a sealed interface inherited by all Kord event types - perhaps named KordEvent. While this would not solve the problem of generic entity extraction, it would allow framework developers to quickly generate a full list of Kord event types when working with these when blocks.

lukellmann commented 8 months ago

Sounds reasonable to me 👍

PR welcome :)

lukellmann commented 5 months ago

I just noticed that this won't be that easy. Right now, Kotlin forces all direct inheritors of a sealed type to be in the same package as the sealed type. However, Kord's events are already placed into different packages.

Also see https://youtrack.jetbrains.com/issue/KT-44895