diff --git a/examples/arc/src/main.rs b/examples/arc/src/main.rs index b1e8402a89..4576404fde 100644 --- 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 index d822c69b76..cf70bd4012 100644 --- 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 index 6a3b9464a1..3894933644 100644 --- 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 index ebb22cef01..897f8f1b38 100644 --- 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 index 2cded2db22..2933750809 100644 --- 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 index 4457a15a43..aa3dafe9b5 100644 --- a/examples/custom_shader/src/main.rs +++ b/examples/custom_shader/src/main.rs @@ -9,13 +9,9 @@ use iced::window; use iced::{Alignment, Color, Element, Length, Subscription}; fn main() -> iced::Result { - iced::application( - "Custom Shader - Iced", - IcedCubes::update, - IcedCubes::view, - ) - .subscription(IcedCubes::subscription) - .run() + iced::program("Custom Shader - Iced", IcedCubes::update, IcedCubes::view) + .subscription(IcedCubes::subscription) + .run() } struct IcedCubes { diff --git a/examples/download_progress/src/main.rs b/examples/download_progress/src/main.rs index 8d7994c8f4..9f4769e009 100644 --- a/examples/download_progress/src/main.rs +++ b/examples/download_progress/src/main.rs @@ -4,13 +4,9 @@ use iced::widget::{button, column, container, progress_bar, text, Column}; use iced::{Alignment, Element, Length, Subscription}; pub fn main() -> iced::Result { - iced::application( - "Download Progress - Iced", - Example::update, - Example::view, - ) - .subscription(Example::subscription) - .run() + iced::program("Download Progress - Iced", Example::update, Example::view) + .subscription(Example::subscription) + .run() } #[derive(Debug)] diff --git a/examples/events/src/main.rs b/examples/events/src/main.rs index e18fe29962..bf568c945e 100644 --- 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 index 4948bd0f0b..7bed272df2 100644 --- 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 index 6cfe395ae0..9c48f4b9b1 100644 --- 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 index e6b521b29a..713e2b70e0 100644 --- 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 index 3261bdcd58..eaa4d57ed4 100644 --- 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 index 6971731067..2453c7f5c2 100644 --- 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 index 439e9ee53b..829996d87e 100644 --- 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 index c737b87ead..0811c08d99 100644 --- 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 index 1a23331da2..b93adf0436 100644 --- 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 index 296a7f54a8..d887c41b50 100644 --- 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 index a6f3c68913..240ae908c1 100644 --- 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 = 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 index c728751690..07ae05d6ae 100644 --- 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 index 40fd6b12f8..b5228f0957 100644 --- 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 index 2496b85b5a..b9eb19cfb8 100644 --- 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 index ce14aacbe2..73268da01d 100644 --- 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 index 75a4d8d6a5..a6ac27a694 100644 --- a/examples/system_information/src/main.rs +++ b/examples/system_information/src/main.rs @@ -2,12 +2,8 @@ use iced::widget::{button, column, container, text}; use iced::{system, Command, Element, Length}; pub fn main() -> iced::Result { - iced::application( - "System Information - Iced", - Example::update, - Example::view, - ) - .run() + iced::program("System Information - Iced", Example::update, Example::view) + .run() } #[derive(Default)] diff --git a/examples/tour/src/main.rs b/examples/tour/src/main.rs index 97ce761c81..be6e24d5fc 100644 --- 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 index 540d927e47..df705b6c1f 100644 --- 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 index 7b7814ae1d..a7391e23f6 100644 --- 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 index 48fc672a3b..ba60db6736 100644 --- 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/program.rs b/src/application/program.rs similarity index 95% rename from src/program.rs rename to src/application/program.rs index b379dccf34..24e00efe48 100644 --- a/src/program.rs +++ b/src/application/program.rs @@ -1,13 +1,3 @@ -//! 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 @@ -15,7 +5,7 @@ //! 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( +pub fn program( title: impl Title, update: impl Update, view: impl for<'a> self::View<'a, State, Message>, @@ -139,14 +129,18 @@ 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 { raw: P, @@ -154,7 +148,7 @@ pub struct Program { } impl Program

{ - /// Runs the [`Program`]. + /// Runs the underlying [`Application`] of the [`Program`]. pub fn run(self) -> Result where Self: 'static, @@ -364,9 +358,7 @@ impl Program

{ /// 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( /// /// 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 { /// 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>`. -/// -/// [`application`]: self::application() pub trait Update { /// 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>`. -/// -/// [`application`]: self::application() pub trait View<'a, State, Message> { /// Produces the widget of the [`Program`]. fn view(&self, state: &'a State) -> impl Into>; diff --git a/src/lib.rs b/src/lib.rs index c21774849a..def020e0bd 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -157,12 +157,11 @@ //! 1. Draw the resulting user interface. //! //! # Usage -//! You can either use the [`application`] builder or implement the [`Application`] +//! You can either use the [`program`] builder or implement the [`Application`] //! trait directly. //! //! [Elm]: https://elm-lang.org/ //! [The Elm Architecture]: https://guide.elm-lang.org/architecture/ -//! [`application`]: application() #![doc( html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg" )] @@ -189,7 +188,6 @@ pub use iced_highlighter as highlighter; mod error; pub mod application; -pub mod program; pub mod settings; pub mod time; pub mod window; @@ -323,7 +321,6 @@ pub use error::Error; pub use event::Event; pub use executor::Executor; pub use font::Font; -pub use program::Program; pub use renderer::Renderer; pub use settings::Settings; pub use subscription::Subscription; @@ -375,16 +372,16 @@ pub type Result = std::result::Result<(), Error>; /// } /// ``` pub fn run( - title: impl program::Title + 'static, - update: impl program::Update + 'static, - view: impl for<'a> program::View<'a, State, Message> + 'static, + title: impl application::Title + 'static, + update: impl application::Update + 'static, + view: impl for<'a> application::View<'a, State, Message> + 'static, ) -> Result where State: Default + 'static, Message: std::fmt::Debug + Send + 'static, { - application(title, update, view).run() + program(title, update, view).run() } #[doc(inline)] -pub use program::application; +pub use application::program;