forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deprecate Events::oldest_id (#15658)

Browse Source 
# Objective

Fixes #15617 

## Solution

The original author confirmed it was not intentional that both these
methods exist.

They do the same, one has the better implementation and the other the
better name.

## Testing

I just ran the unit tests of the module.

---

## Migration Guide

- Change usages of `Events::oldest_id` to `Events::oldest_event_count`
- If `Events::oldest_id` was used to get the actual oldest
`EventId::id`, note that the deprecated method never reliably did that
in the first place as the buffers may contain no id currently.
This commit is contained in:
urben1680 2024-10-05 03:35:44 +02:00 committed by GitHub
parent ddd4b4daf8
commit 2e89e98931
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
crates/bevy_ecs/src/event/collections.rs
View File

@ -114,9 +114,7 @@ impl<E: Event> Default for Events<E> {
impl<E: Event> Events<E> { impl<E: Event> Events<E> {
/// Returns the index of the oldest event stored in the event buffer. /// Returns the index of the oldest event stored in the event buffer.
pub fn oldest_event_count(&self) -> usize { pub fn oldest_event_count(&self) -> usize {
self.events_a self.events_a.start_event_count
.start_event_count
.min(self.events_b.start_event_count)
} }
/// "Sends" an `event` by writing it to the current event buffer. /// "Sends" an `event` by writing it to the current event buffer.
@ -279,7 +277,7 @@ impl<E: Event> Events<E> {
/// Get a specific event by id if it still exists in the events buffer. /// Get a specific event by id if it still exists in the events buffer.
pub fn get_event(&self, id: usize) -> Option<(&E, EventId<E>)> { pub fn get_event(&self, id: usize) -> Option<(&E, EventId<E>)> {
if id < self.oldest_id() { if id < self.oldest_event_count() {
return None; return None;
} }
@ -291,11 +289,6 @@ impl<E: Event> Events<E> {
.map(|instance| (&instance.event, instance.event_id)) .map(|instance| (&instance.event, instance.event_id))
} }
/// Oldest id still in the events buffer.
pub fn oldest_id(&self) -> usize {
self.events_a.start_event_count
}
/// Which event buffer is this event id a part of. /// Which event buffer is this event id a part of.
fn sequence(&self, id: usize) -> &EventSequence<E> { fn sequence(&self, id: usize) -> &EventSequence<E> {
if id < self.events_b.start_event_count { if id < self.events_b.start_event_count {