Merge #1198

1198: Remove lifetime from `SimpleState` and `SimpleTrans` r=torkleyy a=torkleyy Fixes #1178 Related: #1152 Co-authored-by: Thomas Schaller <torkleyy@gmail.com>
amethyst · Dec 4, 2018 · ac6b2b8 · ac6b2b8
2 parents 2c7dc58 + e4f711b
commit ac6b2b8
Show file tree

Hide file tree

Showing 47 changed files with 86 additions and 96 deletions.
diff --git a/amethyst_core/src/frame_limiter.rs b/amethyst_core/src/frame_limiter.rs
@@ -25,7 +25,7 @@
 //! use amethyst::core::frame_limiter::FrameRateLimitStrategy;
 //!
 //! # struct GameState;
-//! # impl<'a, 'b> SimpleState<'a, 'b> for GameState {}
+//! # impl SimpleState for GameState {}
 //! # fn main() -> amethyst::Result<()> {
 //! let mut game = Application::build("./", GameState)?
 //!     .with_frame_limit(

diff --git a/book/src/concepts/state.md b/book/src/concepts/state.md
@@ -102,7 +102,7 @@ struct GameplayState {
     player_count: u8,
 }
 
-impl<'a,'b> SimpleState<'a,'b> for GameplayState {
+impl SimpleState for GameplayState {
     fn on_start(&mut self, _data: StateData<GameData>) {
         println!("Number of players: {}", self.player_count);
     }
@@ -116,7 +116,7 @@ We first declare the `State`'s struct `GameplayState`.
 In this case, we give it some data: `player_count`, a byte.
 
 Then, we implement the `SimpleState` trait for our `GameplayState`.
-`SimpleState` is a shorthand for `State<GameData<'a, 'b>, ()>` where `GameData` is the internal shared data between states.
+`SimpleState` is a shorthand for `State<GameData<'static, 'static>, ()>` where `GameData` is the internal shared data between states.
 
 ### Switching State
 

diff --git a/book/src/concepts/system.md b/book/src/concepts/system.md
@@ -357,8 +357,8 @@ impl Default for Game {
 
 struct GameplayState;
 
-impl<'a, 'b> SimpleState<'a, 'b> for GameplayState {
-    fn update(&mut self, data: &mut StateData<GameData>) -> SimpleTrans<'a, 'b> {
+impl SimpleState for GameplayState {
+    fn update(&mut self, data: &mut StateData<GameData>) -> SimpleTrans {
         // If the `Game` resource has been set up to go back to the menu, pop
         // the state so that we go back.
 
@@ -379,8 +379,8 @@ impl<'a, 'b> SimpleState<'a, 'b> for GameplayState {
 
 struct GameMenuState;
 
-impl<'a, 'b> SimpleState<'a, 'b> for GameMenuState {
-    fn update(&mut self, data: &mut StateData<GameData>) -> SimpleTrans<'a, 'b> {
+impl SimpleState for GameMenuState {
+    fn update(&mut self, data: &mut StateData<GameData>) -> SimpleTrans {
         let mut game = data.world.write_resource::<Game>();
 
         match game.user_action.take() {

diff --git a/book/src/pong-tutorial/pong-tutorial-01.md b/book/src/pong-tutorial/pong-tutorial-01.md
@@ -44,7 +44,7 @@ just implement two methods:
 # use amethyst::renderer::{DisplayConfig, DrawFlat, Pipeline,
 #                          PosTex, RenderBundle, Stage};
 # struct Pong;
-impl<'a, 'b> SimpleState<'a, 'b> for Pong {
+impl SimpleState for Pong {
 }
 ```
 
@@ -166,7 +166,7 @@ Now let's pack everything up and run it:
 # let path = "./resources/display_config.ron";
 # let config = DisplayConfig::load(&path);
 # struct Pong;
-# impl<'a, 'b> SimpleState<'a,'b> for Pong { }
+# impl SimpleState for Pong { }
 let pipe = Pipeline::build()
     .with_stage(
 #        Stage::with_backbuffer()

diff --git a/book/src/pong-tutorial/pong-tutorial-02.md b/book/src/pong-tutorial/pong-tutorial-02.md
@@ -56,7 +56,7 @@ We will leave it empty for now, but it will become useful later down the line.
 # extern crate amethyst;
 # use amethyst::prelude::*;
 # struct MyState;
-# impl<'a, 'b> SimpleState<'a, 'b> for MyState {
+# impl SimpleState for MyState {
 fn on_start(&mut self, data: StateData<GameData>) {
 
 }
@@ -141,7 +141,7 @@ our State's `on_start` method:
 # use amethyst::ecs::World;
 # fn initialise_camera(world: &mut World) { }
 # struct MyState;
-# impl<'a, 'b> SimpleState<'a, 'b> for MyState {
+# impl SimpleState for MyState {
 fn on_start(&mut self, data: StateData<GameData>) {
     let world = data.world;
 
@@ -289,7 +289,7 @@ compiles. Update the `on_start` method to the following:
 # fn initialise_paddles(world: &mut World) { }
 # fn initialise_camera(world: &mut World) { }
 # struct MyState;
-# impl<'a, 'b> SimpleState<'a, 'b> for MyState {
+# impl SimpleState for MyState {
 fn on_start(&mut self, data: StateData<GameData>) {
     let world = data.world;
 
@@ -383,7 +383,7 @@ fn main() -> amethyst::Result<()> {
 #       .with_pass(DrawFlat2D::new()),
 # );
 # struct Pong;
-# impl<'a, 'b> SimpleState<'a, 'b> for Pong { }
+# impl SimpleState for Pong { }
     let game_data = GameDataBuilder::default()
         .with_bundle(
           RenderBundle::new(pipe, Some(config))
@@ -602,7 +602,7 @@ all together in the `on_start()` method:
 # fn initialise_camera(world: &mut World) { }
 # fn load_sprite_sheet(world: &mut World) -> SpriteSheetHandle { unimplemented!() }
 # struct MyState;
-# impl<'a, 'b> SimpleState<'a, 'b> for MyState {
+# impl SimpleState for MyState {
 fn on_start(&mut self, data: StateData<GameData>) {
     let world = data.world;
 

diff --git a/book/src/pong-tutorial/pong-tutorial-03.md b/book/src/pong-tutorial/pong-tutorial-03.md
@@ -76,7 +76,7 @@ let input_bundle = InputBundle::<String, String>::new()
 #       .with_pass(DrawFlat::<PosTex>::new()),
 # );
 # struct Pong;
-# impl<'a, 'b> SimpleState<'a, 'b> for Pong { }
+# impl SimpleState for Pong { }
 let game_data = GameDataBuilder::default()
     .with_bundle(RenderBundle::new(pipe, Some(config)).with_sprite_sheet_processor())?
     .with_bundle(TransformBundle::new())?
@@ -370,7 +370,7 @@ will take care of that for us, as well as set up the storage.
 # fn initialise_camera(world: &mut World) { }
 # fn load_sprite_sheet(world: &mut World) -> SpriteSheetHandle { unimplemented!() }
 # struct MyState;
-# impl<'a, 'b> SimpleState<'a, 'b> for MyState {
+# impl SimpleState for MyState {
 fn on_start(&mut self, data: StateData<GameData>) {
     let world = data.world;
 

diff --git a/book/src/pong-tutorial/pong-tutorial-04.md b/book/src/pong-tutorial/pong-tutorial-04.md
@@ -113,7 +113,7 @@ Finally, let's make sure the code is working as intended by updating the `on_sta
 # fn initialise_camera(world: &mut World) { }
 # fn load_sprite_sheet(world: &mut World) -> SpriteSheetHandle { unimplemented!() }
 # struct MyState;
-# impl<'a, 'b> SimpleState<'a, 'b> for MyState {
+# impl SimpleState for MyState {
 fn on_start(&mut self, data: StateData<GameData>) {
     let world = data.world;
 

diff --git a/book/src/pong-tutorial/pong-tutorial-05.md b/book/src/pong-tutorial/pong-tutorial-05.md
@@ -286,7 +286,7 @@ use amethyst::{
 # 
 # pub struct Pong;
 # 
-# impl<'a, 'b> SimpleState<'a, 'b> for Pong {
+# impl SimpleState for Pong {
 #     fn on_start(&mut self, data: StateData<GameData>) {
 #         let world = data.world;
 # 
@@ -487,7 +487,7 @@ use amethyst::{
 # 
 # pub struct Pong;
 # 
-impl<'a, 'b> SimpleState<'a, 'b> for Pong {
+impl SimpleState for Pong {
     fn on_start(&mut self, data: StateData<GameData>) {
 #         let world = data.world;
 #

diff --git a/book/src/sprites/display_the_texture.md b/book/src/sprites/display_the_texture.md
@@ -44,7 +44,7 @@ fn init_image(world: &mut World, texture_handle: &TextureHandle) {
 #[derive(Debug)]
 struct ExampleState;
 
-impl<'a, 'b> SimpleState<'a, 'b> for ExampleState {
+impl SimpleState for ExampleState {
     fn on_start(&mut self, data: StateData<GameData>) {
         let world = data.world;
         let texture_handle = load_texture("texture/sprite_sheet.png", world);

diff --git a/book/src/sprites/load_the_texture.md b/book/src/sprites/load_the_texture.md
@@ -27,7 +27,7 @@ where
 #[derive(Debug)]
 struct ExampleState;
 
-impl<'a, 'b> SimpleState<'a, 'b> for ExampleState {
+impl SimpleState for ExampleState {
     fn on_start(&mut self, data: StateData<GameData>) {
         let texture_handle = load_texture("texture/sprite_sheet.png", &data.world);
     }

diff --git a/book/src/sprites/orthographic_camera.md b/book/src/sprites/orthographic_camera.md
@@ -16,7 +16,7 @@ use amethyst::renderer::{
 #[derive(Debug)]
 struct ExampleState;
 
-impl<'a, 'b> SimpleState<'a, 'b> for ExampleState {
+impl SimpleState for ExampleState {
     fn on_start(&mut self, mut data: StateData<GameData>) {
         // ...
 

diff --git a/book/src/sprites/set_up_the_render_pass.md b/book/src/sprites/set_up_the_render_pass.md
@@ -20,7 +20,7 @@ use amethyst::renderer::{
 # #[derive(Debug, Default)]
 # struct ExampleState;
 #
-# impl<'a, 'b> SimpleState<'a, 'b> for ExampleState {}
+# impl SimpleState for ExampleState {}
 
 fn main() -> amethyst::Result<()> {
 #     amethyst::start_logger(Default::default());

diff --git a/book/src/sprites/sprite_render_component.md b/book/src/sprites/sprite_render_component.md
@@ -37,7 +37,7 @@ use amethyst::renderer::{
 #[derive(Debug)]
 struct ExampleState;
 
-impl<'a, 'b> SimpleState<'a, 'b> for ExampleState {
+impl SimpleState for ExampleState {
     fn on_start(&mut self, mut data: StateData<GameData>) {
 #         let texture_handle = load_texture("texture/sprite_sheet.png", &data.world);
         // ...
@@ -82,7 +82,7 @@ use amethyst::renderer::{
 #[derive(Debug)]
 struct ExampleState;
 
-impl<'a, 'b> SimpleState<'a, 'b> for ExampleState {
+impl SimpleState for ExampleState {
     fn on_start(&mut self, mut data: StateData<GameData>) {
 #         let texture_handle = load_texture("texture/sprite_sheet.png", &data.world);
 # 

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -43,6 +43,7 @@ The format is based on [Keep a Changelog][kc], and this project adheres to
 * Renamed the `DrawSprite` pass to `DrawFlat2D` as it now handles both sprites and images without spritesheets. ([#1153])
 * `BasicScenePrefab` deserialization now returns an error on invalid fields. ([#1164])
 * Reordered arguments for `Transform::set_rotation_euler` to match nalgebra's Euler angles. ([#1052])
+* Remove lifetimes from `SimpleState` ([#1198])
 
 ### Removed
 
@@ -85,6 +86,7 @@ The format is based on [Keep a Changelog][kc], and this project adheres to
 [#1184]: https://github.com/amethyst/amethyst/pull/1184
 [#1187]: https://github.com/amethyst/amethyst/pull/1187
 [#1188]: https://github.com/amethyst/amethyst/pull/1188
+[#1198]: https://github.com/amethyst/amethyst/pull/1198
 [winit_018]: https://github.com/tomaka/winit/blob/v0.18.0/CHANGELOG.md#version-0180-2018-11-07
 [glutin_019]: https://github.com/tomaka/glutin/blob/master/CHANGELOG.md#version-0190-2018-11-09
 
@@ -703,3 +705,4 @@ The format is based on [Keep a Changelog][kc], and this project adheres to
 [0.4.1]: https://github.com/amethyst/amethyst/compare/v0.4...v0.4.1
 [0.4.0]: https://github.com/amethyst/amethyst/compare/v0.3.1...v0.4
 [0.3.1]: https://github.com/amethyst/amethyst/compare/v0.3...v0.3.1
+
diff --git a/examples/animation/main.rs b/examples/animation/main.rs
@@ -46,7 +46,7 @@ impl Default for Example {
     }
 }
 
-impl<'a, 'b> SimpleState<'a, 'b> for Example {
+impl SimpleState for Example {
     fn on_start(&mut self, data: StateData<GameData>) {
         let StateData { world, .. } = data;
         // Initialise the scene with an object, a light and a camera.
@@ -56,11 +56,7 @@ impl<'a, 'b> SimpleState<'a, 'b> for Example {
         self.sphere = Some(world.create_entity().with(prefab_handle).build());
     }
 
-    fn handle_event(
-        &mut self,
-        data: StateData<GameData>,
-        event: StateEvent,
-    ) -> SimpleTrans<'a, 'b> {
+    fn handle_event(&mut self, data: StateData<GameData>, event: StateEvent) -> SimpleTrans {
         let StateData { world, .. } = data;
         if let StateEvent::Window(event) = &event {
             if is_close_requested(&event) || is_key_down(&event, VirtualKeyCode::Escape) {

diff --git a/examples/appendix_a/pong.rs b/examples/appendix_a/pong.rs
@@ -19,7 +19,7 @@ use crate::{
 
 pub struct Pong;
 
-impl<'a, 'b> SimpleState<'a, 'b> for Pong {
+impl SimpleState for Pong {
     fn on_start(&mut self, data: StateData<GameData>) {
         let StateData { world, .. } = data;
         use crate::audio::initialise_audio;

diff --git a/examples/arc_ball_camera/main.rs b/examples/arc_ball_camera/main.rs
@@ -22,7 +22,7 @@ type MyPrefabData = BasicScenePrefab<Vec<PosNormTex>>;
 
 struct ExampleState;
 
-impl<'a, 'b> SimpleState<'a, 'b> for ExampleState {
+impl SimpleState for ExampleState {
     fn on_start(&mut self, data: StateData<GameData>) {
         let prefab_handle = data.world.exec(|loader: PrefabLoader<MyPrefabData>| {
             loader.load("prefab/arc_ball_camera.ron", RonFormat, (), ())

diff --git a/examples/asset_loading/main.rs b/examples/asset_loading/main.rs
@@ -63,7 +63,7 @@ impl SimpleFormat<Mesh> for Custom {
 
 struct AssetsExample;
 
-impl<'a, 'b> SimpleState<'a, 'b> for AssetsExample {
+impl SimpleState for AssetsExample {
     fn on_start(&mut self, data: StateData<GameData>) {
         let StateData { world, .. } = data;
         world.add_resource(0usize);

diff --git a/examples/custom_ui/main.rs b/examples/custom_ui/main.rs
@@ -75,7 +75,7 @@ impl ToNativeWidget for CustomUi {
 
 struct Example;
 
-impl<'a, 'b> SimpleState<'a, 'b> for Example {
+impl SimpleState for Example {
     fn on_start(&mut self, data: StateData<GameData>) {
         let StateData { world, .. } = data;
         // Initialise the scene with an object, a light and a camera.

diff --git a/examples/debug_lines/main.rs b/examples/debug_lines/main.rs
@@ -44,7 +44,7 @@ impl<'s> System<'s> for ExampleLinesSystem {
 }
 
 struct ExampleState;
-impl<'a, 'b> SimpleState<'a, 'b> for ExampleState {
+impl SimpleState for ExampleState {
     fn on_start(&mut self, data: StateData<GameData>) {
         // Setup debug lines as a resource
         data.world

diff --git a/examples/fly_camera/main.rs b/examples/fly_camera/main.rs
@@ -17,7 +17,7 @@ type MyPrefabData = BasicScenePrefab<Vec<PosNormTex>>;
 
 struct ExampleState;
 
-impl<'a, 'b> SimpleState<'a, 'b> for ExampleState {
+impl SimpleState for ExampleState {
     fn on_start(&mut self, data: StateData<GameData>) {
         let prefab_handle = data.world.exec(|loader: PrefabLoader<MyPrefabData>| {
             loader.load("prefab/fly_camera.ron", RonFormat, (), ())

diff --git a/examples/gltf/main.rs b/examples/gltf/main.rs
@@ -51,7 +51,7 @@ struct ScenePrefabData {
     fly_tag: Option<ControlTagPrefab>,
 }
 
-impl<'a, 'b> SimpleState<'a, 'b> for Example {
+impl SimpleState for Example {
     fn on_start(&mut self, data: StateData<GameData>) {
         let StateData { world, .. } = data;
 
@@ -69,11 +69,7 @@ impl<'a, 'b> SimpleState<'a, 'b> for Example {
         );
     }
 
-    fn handle_event(
-        &mut self,
-        data: StateData<GameData>,
-        event: StateEvent,
-    ) -> SimpleTrans<'a, 'b> {
+    fn handle_event(&mut self, data: StateData<GameData>, event: StateEvent) -> SimpleTrans {
         let StateData { world, .. } = data;
         if let StateEvent::Window(event) = &event {
             if is_close_requested(&event) || is_key_down(&event, VirtualKeyCode::Escape) {
@@ -94,7 +90,7 @@ impl<'a, 'b> SimpleState<'a, 'b> for Example {
         }
     }
 
-    fn update(&mut self, data: &mut StateData<GameData>) -> SimpleTrans<'a, 'b> {
+    fn update(&mut self, data: &mut StateData<GameData>) -> SimpleTrans {
         if !self.initialised {
             let remove = match self.progress.as_ref().map(|p| p.complete()) {
                 None | Some(Completion::Loading) => false,

diff --git a/examples/locale/main.rs b/examples/locale/main.rs
@@ -27,7 +27,7 @@ impl Example {
     }
 }
 
-impl<'a, 'b> SimpleState<'a, 'b> for Example {
+impl SimpleState for Example {
     fn on_start(&mut self, data: StateData<GameData>) {
         data.world.add_resource(AssetStorage::<Locale>::new());
         let mut progress_counter = ProgressCounter::default();
@@ -56,7 +56,7 @@ impl<'a, 'b> SimpleState<'a, 'b> for Example {
         self.progress_counter = Some(progress_counter);
     }
 
-    fn update(&mut self, data: &mut StateData<GameData>) -> SimpleTrans<'a, 'b> {
+    fn update(&mut self, data: &mut StateData<GameData>) -> SimpleTrans {
         // Check if the locale has been loaded.
         if self.progress_counter.as_ref().unwrap().is_complete() {
             let store = data.world.read_resource::<AssetStorage<Locale>>();

diff --git a/examples/material/main.rs b/examples/material/main.rs
@@ -13,7 +13,7 @@ use amethyst::{
 
 struct Example;
 
-impl<'a, 'b> SimpleState<'a, 'b> for Example {
+impl SimpleState for Example {
     fn on_start(&mut self, data: StateData<GameData>) {
         let StateData { world, .. } = data;
         let mat_defaults = world.read_resource::<MaterialDefaults>().0.clone();

diff --git a/examples/net_client/main.rs b/examples/net_client/main.rs
@@ -31,7 +31,7 @@ fn main() -> Result<()> {
 
 /// Default empty state
 pub struct State1;
-impl<'a, 'b> SimpleState<'a, 'b> for State1 {
+impl SimpleState for State1 {
     fn on_start(&mut self, data: StateData<GameData>) {
         data.world
             .create_entity()

diff --git a/examples/net_server/main.rs b/examples/net_server/main.rs
@@ -30,7 +30,7 @@ fn main() -> Result<()> {
 
 /// Default empty state
 pub struct State1;
-impl<'a, 'b> SimpleState<'a, 'b> for State1 {
+impl SimpleState for State1 {
     fn on_start(&mut self, data: StateData<GameData>) {
         data.world
             .create_entity()

diff --git a/examples/pong/pong.rs b/examples/pong/pong.rs
@@ -13,7 +13,7 @@ use crate::{systems::ScoreText, Ball, Paddle, Side, ARENA_HEIGHT, ARENA_WIDTH};
 
 pub struct Pong;
 
-impl<'a, 'b> SimpleState<'a, 'b> for Pong {
+impl SimpleState for Pong {
     fn on_start(&mut self, data: StateData<GameData>) {
         let StateData { world, .. } = data;
         use crate::audio::initialise_audio;