Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 2.23 KB

deprecated-reason.md

File metadata and controls

34 lines (27 loc) · 2.23 KB

Deprecated Reason

This file contains the reason of discontinuing the maintenance of certain modules of the crate bevy-discord

webhook Module

maintenance-status Please Use http module instead of webhook

This module was up until v0.2.2 and will be deprecated in the next release i.e. v0.3.0 (Not released at the time of writing). The main problem with this crate is not the maintenance overhead of code architecture with Bevy but with the serenity.

You might think that this should be the easy part, it only looks like that but the events.rs in module bot is over 700 lines of code that only covers the events struct which is just the representation of 70+ serenity events handle.rs.

Although I used rust macros common.rs in best of my ability to reduce a lot of effort and nonsense maintenance overburden. The module bot was handled in the best possible manner (at least best of my abilities) for the crate to be efficient and performance oriented while reduce maintenance overburden.

You might be thinking that serenity API(s) is only going to change when discord is going to change their API(s), that's correct but for this crate as it's just a wrapper around serenity, I want my minimum effort on maintaining as those events were written manually. (I believe there are more efficient manner to achieve this, but I ignored them for now).

Also, webhook module was providing everything expect a single feature that is provided by serenity Http module but at this moment using Http was quite expensive in bevy-discord. Also, maintaining webhook module is double maintaining as serenity is already doing that. Therefore, I will be introducing a new module named http (WIP at time of writing) in bevy-discord that is going to be a wrapper around serenity Http but with improved performance in bevy environment.