Move Program to application module

hecrj · hecrj · commit 9cfeebbea615 · 2024-03-17T14:17:34.000+01:00
diff --git a/examples/arc/src/main.rs b/examples/arc/src/main.rs
@@ -7,7 +7,7 @@ use iced::widget::canvas::{
 use iced::{Element, Length, Point, Rectangle, Renderer, Subscription, Theme};
 
 pub fn main() -> iced::Result {
-    iced::application("Arc - Iced", Arc::update, Arc::view)
+    iced::program("Arc - Iced", Arc::update, Arc::view)
         .subscription(Arc::subscription)
         .theme(|_| Theme::Dark)
         .antialiasing(true)
diff --git a/examples/bezier_tool/src/main.rs b/examples/bezier_tool/src/main.rs
@@ -3,7 +3,7 @@ use iced::widget::{button, column, text};
 use iced::{Alignment, Element, Length};
 
 pub fn main() -> iced::Result {
-    iced::application("Bezier Tool - Iced", Example::update, Example::view)
+    iced::program("Bezier Tool - Iced", Example::update, Example::view)
         .antialiasing(true)
         .run()
 }
diff --git a/examples/checkbox/src/main.rs b/examples/checkbox/src/main.rs
@@ -4,7 +4,7 @@ use iced::{Element, Font, Length};
 const ICON_FONT: Font = Font::with_name("icons");
 
 pub fn main() -> iced::Result {
-    iced::application("Checkbox - Iced", Example::update, Example::view)
+    iced::program("Checkbox - Iced", Example::update, Example::view)
         .font(include_bytes!("../fonts/icons.ttf").as_slice())
         .run()
 }
diff --git a/examples/clock/src/main.rs b/examples/clock/src/main.rs
@@ -8,7 +8,7 @@ use iced::{
 };
 
 pub fn main() -> iced::Result {
-    iced::application("Clock - Iced", Clock::update, Clock::view)
+    iced::program("Clock - Iced", Clock::update, Clock::view)
         .subscription(Clock::subscription)
         .theme(Clock::theme)
         .antialiasing(true)
diff --git a/examples/color_palette/src/main.rs b/examples/color_palette/src/main.rs
@@ -13,7 +13,7 @@ use std::marker::PhantomData;
 use std::ops::RangeInclusive;
 
 pub fn main() -> iced::Result {
-    iced::application(
+    iced::program(
         "Color Palette - Iced",
         ColorPalette::update,
         ColorPalette::view,
diff --git a/examples/custom_shader/src/main.rs b/examples/custom_shader/src/main.rs
@@ -9,7 +9,7 @@ use iced::window;
 use iced::{Alignment, Color, Element, Length, Subscription};
 
 fn main() -> iced::Result {
-    iced::application(
+    iced::program(
         "Custom Shader - Iced",
         IcedCubes::update,
         IcedCubes::view,
diff --git a/examples/download_progress/src/main.rs b/examples/download_progress/src/main.rs
@@ -4,7 +4,7 @@ use iced::widget::{button, column, container, progress_bar, text, Column};
 use iced::{Alignment, Element, Length, Subscription};
 
 pub fn main() -> iced::Result {
-    iced::application(
+    iced::program(
         "Download Progress - Iced",
         Example::update,
         Example::view,
diff --git a/examples/events/src/main.rs b/examples/events/src/main.rs
@@ -5,7 +5,7 @@ use iced::window;
 use iced::{Alignment, Command, Element, Length, Subscription};
 
 pub fn main() -> iced::Result {
-    iced::application("Events - Iced", Events::update, Events::view)
+    iced::program("Events - Iced", Events::update, Events::view)
         .subscription(Events::subscription)
         .exit_on_close_request(false)
         .run()
diff --git a/examples/exit/src/main.rs b/examples/exit/src/main.rs
@@ -3,7 +3,7 @@ use iced::window;
 use iced::{Alignment, Command, Element, Length};
 
 pub fn main() -> iced::Result {
-    iced::application("Exit - Iced", Exit::update, Exit::view).run()
+    iced::program("Exit - Iced", Exit::update, Exit::view).run()
 }
 
 #[derive(Default)]
diff --git a/examples/gradient/src/main.rs b/examples/gradient/src/main.rs
@@ -8,7 +8,7 @@ use iced::{Alignment, Color, Element, Length, Radians, Theme};
 pub fn main() -> iced::Result {
     tracing_subscriber::fmt::init();
 
-    iced::application("Gradient - Iced", Gradient::update, Gradient::view)
+    iced::program("Gradient - Iced", Gradient::update, Gradient::view)
         .style(Gradient::style)
         .transparent(true)
         .run()
diff --git a/examples/layout/src/main.rs b/examples/layout/src/main.rs
@@ -10,7 +10,7 @@ use iced::{
 };
 
 pub fn main() -> iced::Result {
-    iced::application(Layout::title, Layout::update, Layout::view)
+    iced::program(Layout::title, Layout::update, Layout::view)
         .subscription(Layout::subscription)
         .theme(Layout::theme)
         .run()
diff --git a/examples/loading_spinners/src/main.rs b/examples/loading_spinners/src/main.rs
@@ -11,7 +11,7 @@ use circular::Circular;
 use linear::Linear;
 
 pub fn main() -> iced::Result {
-    iced::application(
+    iced::program(
         "Loading Spinners - Iced",
         LoadingSpinners::update,
         LoadingSpinners::view,
diff --git a/examples/multitouch/src/main.rs b/examples/multitouch/src/main.rs
@@ -13,7 +13,7 @@ use std::collections::HashMap;
 pub fn main() -> iced::Result {
     tracing_subscriber::fmt::init();
 
-    iced::application("Multitouch - Iced", Multitouch::update, Multitouch::view)
+    iced::program("Multitouch - Iced", Multitouch::update, Multitouch::view)
         .antialiasing(true)
         .centered()
         .run()
diff --git a/examples/pane_grid/src/main.rs b/examples/pane_grid/src/main.rs
@@ -7,7 +7,7 @@ use iced::widget::{
 use iced::{Color, Element, Length, Size, Subscription};
 
 pub fn main() -> iced::Result {
-    iced::application("Pane Grid - Iced", Example::update, Example::view)
+    iced::program("Pane Grid - Iced", Example::update, Example::view)
         .subscription(Example::subscription)
         .run()
 }
diff --git a/examples/pokedex/src/main.rs b/examples/pokedex/src/main.rs
@@ -3,7 +3,7 @@ use iced::widget::{self, column, container, image, row, text};
 use iced::{Alignment, Command, Element, Length};
 
 pub fn main() -> iced::Result {
-    iced::application(Pokedex::title, Pokedex::update, Pokedex::view)
+    iced::program(Pokedex::title, Pokedex::update, Pokedex::view)
         .load(Pokedex::search)
         .run()
 }
diff --git a/examples/qr_code/src/main.rs b/examples/qr_code/src/main.rs
@@ -4,7 +4,7 @@ use iced::widget::{
 use iced::{Alignment, Element, Length, Theme};
 
 pub fn main() -> iced::Result {
-    iced::application(
+    iced::program(
         "QR Code Generator - Iced",
         QRGenerator::update,
         QRGenerator::view,
diff --git a/examples/screenshot/src/main.rs b/examples/screenshot/src/main.rs
@@ -13,7 +13,7 @@ use ::image::ColorType;
 fn main() -> iced::Result {
     tracing_subscriber::fmt::init();
 
-    iced::application("Screenshot - Iced", Example::update, Example::view)
+    iced::program("Screenshot - Iced", Example::update, Example::view)
         .subscription(Example::subscription)
         .run()
 }
diff --git a/examples/scrollable/src/main.rs b/examples/scrollable/src/main.rs
@@ -10,7 +10,7 @@ use once_cell::sync::Lazy;
 static SCROLLABLE_ID: Lazy<scrollable::Id> = Lazy::new(scrollable::Id::unique);
 
 pub fn main() -> iced::Result {
-    iced::application(
+    iced::program(
         "Scrollable - Iced",
         ScrollableDemo::update,
         ScrollableDemo::view,
diff --git a/examples/sierpinski_triangle/src/main.rs b/examples/sierpinski_triangle/src/main.rs
@@ -8,7 +8,7 @@ use rand::Rng;
 use std::fmt::Debug;
 
 fn main() -> iced::Result {
-    iced::application(
+    iced::program(
         "Sierpinski Triangle - Iced",
         SierpinskiEmulator::update,
         SierpinskiEmulator::view,
diff --git a/examples/solar_system/src/main.rs b/examples/solar_system/src/main.rs
@@ -22,7 +22,7 @@ use std::time::Instant;
 pub fn main() -> iced::Result {
     tracing_subscriber::fmt::init();
 
-    iced::application(
+    iced::program(
         "Solar System - Iced",
         SolarSystem::update,
         SolarSystem::view,
diff --git a/examples/stopwatch/src/main.rs b/examples/stopwatch/src/main.rs
@@ -7,7 +7,7 @@ use iced::{Alignment, Element, Length, Subscription, Theme};
 use std::time::{Duration, Instant};
 
 pub fn main() -> iced::Result {
-    iced::application("Stopwatch - Iced", Stopwatch::update, Stopwatch::view)
+    iced::program("Stopwatch - Iced", Stopwatch::update, Stopwatch::view)
         .subscription(Stopwatch::subscription)
         .theme(Stopwatch::theme)
         .run()
diff --git a/examples/styling/src/main.rs b/examples/styling/src/main.rs
@@ -6,7 +6,7 @@ use iced::widget::{
 use iced::{Alignment, Element, Length, Theme};
 
 pub fn main() -> iced::Result {
-    iced::application("Styling - Iced", Styling::update, Styling::view)
+    iced::program("Styling - Iced", Styling::update, Styling::view)
         .theme(Styling::theme)
         .run()
 }
diff --git a/examples/system_information/src/main.rs b/examples/system_information/src/main.rs
@@ -2,7 +2,7 @@ use iced::widget::{button, column, container, text};
 use iced::{system, Command, Element, Length};
 
 pub fn main() -> iced::Result {
-    iced::application(
+    iced::program(
         "System Information - Iced",
         Example::update,
         Example::view,
diff --git a/examples/tour/src/main.rs b/examples/tour/src/main.rs
@@ -16,7 +16,7 @@ pub fn main() -> iced::Result {
     #[cfg(not(target_arch = "wasm32"))]
     tracing_subscriber::fmt::init();
 
-    iced::application(Tour::title, Tour::update, Tour::view)
+    iced::program(Tour::title, Tour::update, Tour::view)
         .centered()
         .run()
 }
diff --git a/examples/url_handler/src/main.rs b/examples/url_handler/src/main.rs
@@ -3,7 +3,7 @@ use iced::widget::{container, text};
 use iced::{Element, Length, Subscription};
 
 pub fn main() -> iced::Result {
-    iced::application("URL Handler - Iced", App::update, App::view)
+    iced::program("URL Handler - Iced", App::update, App::view)
         .subscription(App::subscription)
         .run()
 }
diff --git a/examples/vectorial_text/src/main.rs b/examples/vectorial_text/src/main.rs
@@ -6,7 +6,7 @@ use iced::widget::{
 use iced::{Element, Length, Point, Rectangle, Renderer, Theme, Vector};
 
 pub fn main() -> iced::Result {
-    iced::application(
+    iced::program(
         "Vectorial Text - Iced",
         VectorialText::update,
         VectorialText::view,
diff --git a/src/application.rs b/src/application.rs
@@ -1,7 +1,10 @@
 //! Build interactive cross-platform applications.
-use crate::{Command, Element, Executor, Settings, Subscription};
+mod program;
+
+pub use program::{program, Definition, Program, Title, Update, View};
 
 use crate::shell::application;
+use crate::{Command, Element, Executor, Settings, Subscription};
 
 pub use application::{default, Appearance, DefaultStyle};
 
diff --git a/src/application/program.rs b/src/application/program.rs
@@ -1,21 +1,11 @@
-//! Create iced applications out of simple functions.
-//!
-//! You can use this API to create and run iced applications
-//! step by step—without coupling your logic to a trait
-//! or a specific type.
-//!
-//! This API is meant to be a more convenient—although less
-//! powerful—alternative to the [`Application`] traits.
-//!
-//! [`Sandbox`]: crate::Sandbox
 //!
 //! # Example
 //! ```no_run
 //! use iced::widget::{button, column, text, Column};
 //! use iced::Theme;
 //!
 //! pub fn main() -> iced::Result {
-//!     iced::application("A counter", update, view)
+//!     iced::program("A counter", update, view)
 //!         .theme(|_| Theme::Dark)
 //!         .centered()
 //!         .run()
@@ -53,7 +43,7 @@ use std::borrow::Cow;
 /// use iced::widget::{button, column, text, Column};
 ///
 /// pub fn main() -> iced::Result {
-///     iced::application("A counter", update, view).run()
+///     iced::program("A counter", update, view).run()
 /// }
 ///
 /// #[derive(Debug, Clone)]
@@ -74,7 +64,7 @@ use std::borrow::Cow;
 ///     ]
 /// }
 /// ```
-pub fn application<State, Message>(
+pub fn program<State, Message>(
     title: impl Title<State>,
     update: impl Update<State, Message>,
     view: impl for<'a> self::View<'a, State, Message>,
@@ -139,22 +129,26 @@ where
     .title(title)
 }
 
-/// A fully functioning and configured iced application.
+/// The underlying definition and configuration of an iced [`Application`].
+///
+/// You can use this API to create and run iced applications
+/// step by step—without coupling your logic to a trait
+/// or a specific type.
 ///
-/// It can be [`run`]!
+/// This API is meant to be a more convenient—although less
+/// powerful—alternative to the [`Application`] trait.
 ///
-/// Create one with the [`application`] helper.
+/// You can create a [`Program`] with the [`program`] helper.
 ///
 /// [`run`]: Program::run
-/// [`application`]: self::application()
 #[derive(Debug)]
 pub struct Program<P: Definition> {
     raw: P,
     settings: Settings,
 }
 
 impl<P: Definition> Program<P> {
-    /// Runs the [`Program`].
+    /// Runs the underlying [`Application`] of the [`Program`].
     pub fn run(self) -> Result
     where
         Self: 'static,
@@ -364,9 +358,7 @@ impl<P: Definition> Program<P> {
 /// The internal definition of a [`Program`].
 ///
 /// You should not need to implement this trait directly. Instead, use the
-/// helper functions available in the [`program`] module and the [`Program`] struct.
-///
-/// [`program`]: crate::program
+/// methods available in the [`Program`] struct.
 #[allow(missing_docs)]
 pub trait Definition: Sized {
     /// The state of the program.
@@ -748,6 +740,8 @@ fn with_style<P: Definition>(
 ///
 /// This trait is implemented both for `&static str` and
 /// any closure `Fn(&State) -> String`.
+///
+/// This trait allows the [`program`] builder to take any of them.
 pub trait Title<State> {
     /// Produces the title of the [`Program`].
     fn title(&self, state: &State) -> String;
@@ -770,10 +764,8 @@ where
 
 /// The update logic of some [`Program`].
 ///
-/// This trait allows [`application`] to take any closure that
+/// This trait allows the [`program`] builder to take any closure that
 /// returns any `Into<Command<Message>>`.
-///
-/// [`application`]: self::application()
 pub trait Update<State, Message> {
     /// Processes the message and updates the state of the [`Program`].
     fn update(
@@ -799,10 +791,8 @@ where
 
 /// The view logic of some [`Program`].
 ///
-/// This trait allows [`application`] to take any closure that
+/// This trait allows the [`program`] builder to take any closure that
 /// returns any `Into<Element<'_, Message>>`.
-///
-/// [`application`]: self::application()
 pub trait View<'a, State, Message> {
     /// Produces the widget of the [`Program`].
     fn view(&self, state: &'a State) -> impl Into<Element<'a, Message>>;
diff --git a/src/lib.rs b/src/lib.rs

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ use iced::widget::{button, column, text};`
`3`	`3`	`use iced::{Alignment, Element, Length};`
`4`	`4`
`5`	`5`	`pub fn main() -> iced::Result {`
`6`		`- iced::application("Bezier Tool - Iced", Example::update, Example::view)`
	`6`	`+ iced::program("Bezier Tool - Iced", Example::update, Example::view)`
`7`	`7`	`.antialiasing(true)`
`8`	`8`	`.run()`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ use iced::{Element, Font, Length};`
`4`	`4`	`const ICON_FONT: Font = Font::with_name("icons");`
`5`	`5`
`6`	`6`	`pub fn main() -> iced::Result {`
`7`		`- iced::application("Checkbox - Iced", Example::update, Example::view)`
	`7`	`+ iced::program("Checkbox - Iced", Example::update, Example::view)`
`8`	`8`	`.font(include_bytes!("../fonts/icons.ttf").as_slice())`
`9`	`9`	`.run()`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ use iced::window;`
`3`	`3`	`use iced::{Alignment, Command, Element, Length};`
`4`	`4`
`5`	`5`	`pub fn main() -> iced::Result {`
`6`		`- iced::application("Exit - Iced", Exit::update, Exit::view).run()`
	`6`	`+ iced::program("Exit - Iced", Exit::update, Exit::view).run()`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`#[derive(Default)]`