//! 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) //! .theme(|_| Theme::Dark) //! .centered() //! .run() //! } //! //! #[derive(Debug, Clone)] //! enum Message { //! Increment, //! } //! //! fn update(value: &mut u64, message: Message) { //! match message { //! Message::Increment => *value += 1, //! } //! } //! //! fn view(value: &u64) -> Column { //! column![ //! text(value), //! button("+").on_press(Message::Increment), //! ] //! } //! ``` use crate::application::{self, Application}; use crate::executor::{self, Executor}; use crate::window; use crate::{Command, Element, Font, Result, Settings, Subscription}; use std::borrow::Cow; /// Creates an iced [`Program`] given its title, update, and view logic. /// /// # Example /// ```no_run /// use iced::widget::{button, column, text, Column}; /// /// pub fn main() -> iced::Result { /// iced::application("A counter", update, view).run() /// } /// /// #[derive(Debug, Clone)] /// enum Message { /// Increment, /// } /// /// fn update(value: &mut u64, message: Message) { /// match message { /// Message::Increment => *value += 1, /// } /// } /// /// fn view(value: &u64) -> Column { /// column![ /// text(value), /// button("+").on_press(Message::Increment), /// ] /// } /// ``` pub fn application( title: impl Title, update: impl Update, view: impl for<'a> self::View<'a, State, Message>, ) -> Program< impl Definition, > where State: Default + 'static, Message: Send + std::fmt::Debug, { use std::marker::PhantomData; struct Application { update: Update, view: View, _state: PhantomData, _message: PhantomData, } impl Definition for Application where State: Default, Message: Send + std::fmt::Debug, Update: self::Update, View: for<'a> self::View<'a, State, Message>, { type State = State; type Message = Message; type Theme = crate::Theme; type Executor = executor::Default; fn build(&self) -> (Self::State, Command) { (Self::State::default(), Command::none()) } fn update( &self, state: &mut Self::State, message: Self::Message, ) -> Command { self.update.update(state, message).into() } fn view<'a>( &self, state: &'a Self::State, ) -> Element<'a, Self::Message, Self::Theme> { self.view.view(state).into() } } Program { raw: Application { update, view, _state: PhantomData, _message: PhantomData, }, settings: Settings::default(), } .title(title) } /// A fully functioning and configured iced application. /// /// It can be [`run`]! /// /// Create one with the [`application`] helper. /// /// [`run`]: Program::run /// [`application`]: self::application() #[derive(Debug)] pub struct Program { raw: P, settings: Settings, } impl Program

{ /// Runs the [`Program`]. pub fn run(self) -> Result where Self: 'static, { struct Instance { program: P, state: P::State, } impl Application for Instance

{ type Message = P::Message; type Theme = P::Theme; type Flags = P; type Executor = P::Executor; fn new(program: Self::Flags) -> (Self, Command) { let (state, command) = P::build(&program); (Self { program, state }, command) } fn title(&self) -> String { self.program.title(&self.state) } fn update( &mut self, message: Self::Message, ) -> Command { self.program.update(&mut self.state, message) } fn view( &self, ) -> crate::Element<'_, Self::Message, Self::Theme, crate::Renderer> { self.program.view(&self.state) } fn subscription(&self) -> Subscription { self.program.subscription(&self.state) } fn theme(&self) -> Self::Theme { self.program.theme(&self.state) } fn style(&self, theme: &Self::Theme) -> application::Appearance { self.program.style(&self.state, theme) } } let Self { raw, settings } = self; Instance::run(Settings { flags: raw, id: settings.id, window: settings.window, fonts: settings.fonts, default_font: settings.default_font, default_text_size: settings.default_text_size, antialiasing: settings.antialiasing, }) } /// Sets the [`Settings`] that will be used to run the [`Program`]. pub fn settings(self, settings: Settings) -> Self { Self { settings, ..self } } /// Sets the [`Settings::antialiasing`] of the [`Program`]. pub fn antialiasing(self, antialiasing: bool) -> Self { Self { settings: Settings { antialiasing, ..self.settings }, ..self } } /// Sets the default [`Font`] of the [`Program`]. pub fn default_font(self, default_font: Font) -> Self { Self { settings: Settings { default_font, ..self.settings }, ..self } } /// Adds a font to the list of fonts that will be loaded at the start of the [`Program`]. pub fn font(mut self, font: impl Into>) -> Self { self.settings.fonts.push(font.into()); self } /// Sets the [`window::Settings::position`] to [`window::Position::Centered`] in the [`Program`]. pub fn centered(self) -> Self { Self { settings: Settings { window: window::Settings { position: window::Position::Centered, ..self.settings.window }, ..self.settings }, ..self } } /// Sets the [`window::Settings::exit_on_close_request`] of the [`Program`]. pub fn exit_on_close_request(self, exit_on_close_request: bool) -> Self { Self { settings: Settings { window: window::Settings { exit_on_close_request, ..self.settings.window }, ..self.settings }, ..self } } /// Sets the [`window::Settings::transparent`] of the [`Program`]. pub fn transparent(self, transparent: bool) -> Self { Self { settings: Settings { window: window::Settings { transparent, ..self.settings.window }, ..self.settings }, ..self } } /// Sets the [`Title`] of the [`Program`]. pub(crate) fn title( self, title: impl Title, ) -> Program< impl Definition, > { Program { raw: with_title(self.raw, title), settings: self.settings, } } /// Runs the [`Command`] produced by the closure at startup. pub fn load( self, f: impl Fn() -> Command, ) -> Program< impl Definition, > { Program { raw: with_load(self.raw, f), settings: self.settings, } } /// Sets the subscription logic of the [`Program`]. pub fn subscription( self, f: impl Fn(&P::State) -> Subscription, ) -> Program< impl Definition, > { Program { raw: with_subscription(self.raw, f), settings: self.settings, } } /// Sets the theme logic of the [`Program`]. pub fn theme( self, f: impl Fn(&P::State) -> P::Theme, ) -> Program< impl Definition, > { Program { raw: with_theme(self.raw, f), settings: self.settings, } } /// Sets the style logic of the [`Program`]. pub fn style( self, f: impl Fn(&P::State, &P::Theme) -> application::Appearance, ) -> Program< impl Definition, > { Program { raw: with_style(self.raw, f), settings: self.settings, } } } /// 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 #[allow(missing_docs)] pub trait Definition: Sized { /// The state of the program. type State; /// The message of the program. type Message: Send + std::fmt::Debug; /// The theme of the program. type Theme: Default + application::DefaultStyle; /// The executor of the program. type Executor: Executor; fn build(&self) -> (Self::State, Command); fn update( &self, state: &mut Self::State, message: Self::Message, ) -> Command; fn view<'a>( &self, state: &'a Self::State, ) -> Element<'a, Self::Message, Self::Theme>; fn title(&self, _state: &Self::State) -> String { String::from("A cool iced application!") } fn subscription( &self, _state: &Self::State, ) -> Subscription { Subscription::none() } fn theme(&self, _state: &Self::State) -> Self::Theme { Self::Theme::default() } fn style( &self, _state: &Self::State, theme: &Self::Theme, ) -> application::Appearance { application::DefaultStyle::default_style(theme) } } fn with_title( program: P, title: impl Title, ) -> impl Definition { struct WithTitle { program: P, title: Title, } impl Definition for WithTitle where P: Definition, Title: self::Title, { type State = P::State; type Message = P::Message; type Theme = P::Theme; type Executor = P::Executor; fn build(&self) -> (Self::State, Command) { self.program.build() } fn title(&self, state: &Self::State) -> String { self.title.title(state) } fn update( &self, state: &mut Self::State, message: Self::Message, ) -> Command { self.program.update(state, message) } fn view<'a>( &self, state: &'a Self::State, ) -> Element<'a, Self::Message, Self::Theme> { self.program.view(state) } fn theme(&self, state: &Self::State) -> Self::Theme { self.program.theme(state) } fn subscription( &self, state: &Self::State, ) -> Subscription { self.program.subscription(state) } fn style( &self, state: &Self::State, theme: &Self::Theme, ) -> application::Appearance { self.program.style(state, theme) } } WithTitle { program, title } } fn with_load( program: P, f: impl Fn() -> Command, ) -> impl Definition { struct WithLoad { program: P, load: F, } impl Definition for WithLoad where F: Fn() -> Command, { type State = P::State; type Message = P::Message; type Theme = P::Theme; type Executor = executor::Default; fn build(&self) -> (Self::State, Command) { let (state, command) = self.program.build(); (state, Command::batch([command, (self.load)()])) } fn update( &self, state: &mut Self::State, message: Self::Message, ) -> Command { self.program.update(state, message) } fn view<'a>( &self, state: &'a Self::State, ) -> Element<'a, Self::Message, Self::Theme> { self.program.view(state) } fn title(&self, state: &Self::State) -> String { self.program.title(state) } fn subscription( &self, state: &Self::State, ) -> Subscription { self.program.subscription(state) } fn theme(&self, state: &Self::State) -> Self::Theme { self.program.theme(state) } fn style( &self, state: &Self::State, theme: &Self::Theme, ) -> application::Appearance { self.program.style(state, theme) } } WithLoad { program, load: f } } fn with_subscription( program: P, f: impl Fn(&P::State) -> Subscription, ) -> impl Definition { struct WithSubscription { program: P, subscription: F, } impl Definition for WithSubscription where F: Fn(&P::State) -> Subscription, { type State = P::State; type Message = P::Message; type Theme = P::Theme; type Executor = executor::Default; fn subscription( &self, state: &Self::State, ) -> Subscription { (self.subscription)(state) } fn build(&self) -> (Self::State, Command) { self.program.build() } fn update( &self, state: &mut Self::State, message: Self::Message, ) -> Command { self.program.update(state, message) } fn view<'a>( &self, state: &'a Self::State, ) -> Element<'a, Self::Message, Self::Theme> { self.program.view(state) } fn title(&self, state: &Self::State) -> String { self.program.title(state) } fn theme(&self, state: &Self::State) -> Self::Theme { self.program.theme(state) } fn style( &self, state: &Self::State, theme: &Self::Theme, ) -> application::Appearance { self.program.style(state, theme) } } WithSubscription { program, subscription: f, } } fn with_theme( program: P, f: impl Fn(&P::State) -> P::Theme, ) -> impl Definition { struct WithTheme { program: P, theme: F, } impl Definition for WithTheme where F: Fn(&P::State) -> P::Theme, { type State = P::State; type Message = P::Message; type Theme = P::Theme; type Executor = P::Executor; fn theme(&self, state: &Self::State) -> Self::Theme { (self.theme)(state) } fn build(&self) -> (Self::State, Command) { self.program.build() } fn title(&self, state: &Self::State) -> String { self.program.title(state) } fn update( &self, state: &mut Self::State, message: Self::Message, ) -> Command { self.program.update(state, message) } fn view<'a>( &self, state: &'a Self::State, ) -> Element<'a, Self::Message, Self::Theme> { self.program.view(state) } fn subscription( &self, state: &Self::State, ) -> Subscription { self.program.subscription(state) } fn style( &self, state: &Self::State, theme: &Self::Theme, ) -> application::Appearance { self.program.style(state, theme) } } WithTheme { program, theme: f } } fn with_style( program: P, f: impl Fn(&P::State, &P::Theme) -> application::Appearance, ) -> impl Definition { struct WithStyle { program: P, style: F, } impl Definition for WithStyle where F: Fn(&P::State, &P::Theme) -> application::Appearance, { type State = P::State; type Message = P::Message; type Theme = P::Theme; type Executor = P::Executor; fn style( &self, state: &Self::State, theme: &Self::Theme, ) -> application::Appearance { (self.style)(state, theme) } fn build(&self) -> (Self::State, Command) { self.program.build() } fn title(&self, state: &Self::State) -> String { self.program.title(state) } fn update( &self, state: &mut Self::State, message: Self::Message, ) -> Command { self.program.update(state, message) } fn view<'a>( &self, state: &'a Self::State, ) -> Element<'a, Self::Message, Self::Theme> { self.program.view(state) } fn subscription( &self, state: &Self::State, ) -> Subscription { self.program.subscription(state) } fn theme(&self, state: &Self::State) -> Self::Theme { self.program.theme(state) } } WithStyle { program, style: f } } /// The title logic of some [`Program`]. /// /// This trait is implemented both for `&static str` and /// any closure `Fn(&State) -> String`. pub trait Title { /// Produces the title of the [`Program`]. fn title(&self, state: &State) -> String; } impl Title for &'static str { fn title(&self, _state: &State) -> String { self.to_string() } } impl Title for T where T: Fn(&State) -> String, { fn title(&self, state: &State) -> String { self(state) } } /// The update logic of some [`Program`]. /// /// This trait allows [`application`] 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( &self, state: &mut State, message: Message, ) -> impl Into>; } impl Update for T where T: Fn(&mut State, Message) -> C, C: Into>, { fn update( &self, state: &mut State, message: Message, ) -> impl Into> { self(state, message) } } /// The view logic of some [`Program`]. /// /// This trait allows [`application`] 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>; } impl<'a, T, State, Message, Widget> View<'a, State, Message> for T where T: Fn(&'a State) -> Widget, State: 'static, Widget: Into>, { fn view(&self, state: &'a State) -> impl Into> { self(state) } }