[Merged by Bors] - `Gamepad` type is `Copy`; do not require / return references to it in `Gamepads` API #5296

alice-i-cecile · 2022-07-12T13:28:47Z

Objective

The Gamepad type is a tiny value-containing type that implements Copy.
By convention, references to Copy types should be avoided, as they can introduce overhead and muddle the semantics of what's going on.
This allows us to reduce boilerplate reference manipulation and lifetimes in user facing code.

Solution

Make assorted methods on Gamepads take / return a raw Gamepad, rather than &Gamepad.

Migration Guide

Gamepads::iter now returns an iterator of Gamepad. rather than an iterator of &Gamepad.
Gamepads::contains now accepts a Gamepad, rather than a &Gamepad.

Nilirad · 2022-07-12T18:41:13Z

Labeled as breaking change since it changes function signatures.

hymm

LGTM

crates/bevy_input/src/gamepad.rs

Co-authored-by: ira <JustTheCoolDude@gmail.com>

alice-i-cecile · 2022-09-03T18:32:48Z

bors r+

… `Gamepads` API (#5296) # Objective - The `Gamepad` type is a tiny value-containing type that implements `Copy`. - By convention, references to `Copy` types should be avoided, as they can introduce overhead and muddle the semantics of what's going on. - This allows us to reduce boilerplate reference manipulation and lifetimes in user facing code. ## Solution - Make assorted methods on `Gamepads` take / return a raw `Gamepad`, rather than `&Gamepad`. ## Migration Guide - `Gamepads::iter` now returns an iterator of `Gamepad`. rather than an iterator of `&Gamepad`. - `Gamepads::contains` now accepts a `Gamepad`, rather than a `&Gamepad`.

bors · 2022-09-03T18:36:05Z

Build failed:

check-doc

crates/bevy_input/src/gamepad.rs

Co-authored-by: TimJentzsch <tim-jentzsch@gmx.de>

alice-i-cecile · 2022-09-03T20:08:10Z

bors retry

… `Gamepads` API (#5296) # Objective - The `Gamepad` type is a tiny value-containing type that implements `Copy`. - By convention, references to `Copy` types should be avoided, as they can introduce overhead and muddle the semantics of what's going on. - This allows us to reduce boilerplate reference manipulation and lifetimes in user facing code. ## Solution - Make assorted methods on `Gamepads` take / return a raw `Gamepad`, rather than `&Gamepad`. ## Migration Guide - `Gamepads::iter` now returns an iterator of `Gamepad`. rather than an iterator of `&Gamepad`. - `Gamepads::contains` now accepts a `Gamepad`, rather than a `&Gamepad`.

bors · 2022-09-03T20:22:58Z

Pull request successfully merged into main.

Build succeeded:

… `Gamepads` API (bevyengine#5296) # Objective - The `Gamepad` type is a tiny value-containing type that implements `Copy`. - By convention, references to `Copy` types should be avoided, as they can introduce overhead and muddle the semantics of what's going on. - This allows us to reduce boilerplate reference manipulation and lifetimes in user facing code. ## Solution - Make assorted methods on `Gamepads` take / return a raw `Gamepad`, rather than `&Gamepad`. ## Migration Guide - `Gamepads::iter` now returns an iterator of `Gamepad`. rather than an iterator of `&Gamepad`. - `Gamepads::contains` now accepts a `Gamepad`, rather than a `&Gamepad`.

Gamepad type is Copy; do not take & to it

5f74cc5

alice-i-cecile added A-Input Player input via keyboard, mouse, gamepad, and more C-Code-Quality A section of code that is hard to understand or change C-Usability A targeted quality-of-life change that makes Bevy easier to use labels Jul 12, 2022

Nilirad added the M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Jul 12, 2022

hymm approved these changes Jul 13, 2022

View reviewed changes

Merge branch 'main' into gamepads-iter

6aa3ab3

alice-i-cecile commented Sep 3, 2022

View reviewed changes