Struct iced::pure::Pure

pub struct Pure<'a, Message, Renderer> { /* private fields */ }

Available on crate feature pure only.

A bridge between impure and pure widgets.

If you already have an existing iced application, you do not need to switch completely to the new traits in order to benefit from the pure module. Instead, you can leverage the new Pure widget to include pure widgets in your impure Application.

For instance, let’s say we want to use our pure Counter in an impure application:

use iced_pure::{self, Pure};

struct Impure {
    state: pure::State,
    counter: Counter,
}

impl Sandbox for Impure {
    // ...

    pub fn view(&mut self) -> Element<Self::Message> {
        Pure::new(&mut self.state, self.counter.view()).into()
    }
}

Pure acts as a bridge between pure and impure widgets. It is completely opt-in and can be used to slowly migrate your application to the new architecture.

The purification of your application may trigger a bunch of important refactors, since it’s far easier to keep your data decoupled from the GUI state with stateless widgets. For this reason, I recommend starting small in the most nested views of your application and slowly expand the purity upwards.

Implementations

impl<'a, Message, Renderer> Pure<'a, Message, Renderer> where
    Message: 'a,
    Renderer: 'a + Renderer, 

pub fn new(
    state: &'a mut State,
    content: impl Into<Element<'a, Message, Renderer>>
) -> Pure<'a, Message, Renderer>

Creates a new Pure widget with the given State and impure Element.

Trait Implementations

impl<'a, Message, Renderer> Into<Element<'a, Message, Renderer>> for Pure<'a, Message, Renderer> where
    Message: 'a,
    Renderer: 'a + Renderer, 

fn into(self) -> Element<'a, Message, Renderer>

Converts this type into the (usually inferred) input type.

impl<'a, Message, Renderer> Widget<Message, Renderer> for Pure<'a, Message, Renderer> where
    Message: 'a,
    Renderer: 'a + Renderer, 

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

fn layout(&self, renderer: &Renderer, limits: &Limits) -> Node

Returns the Node of the Widget.

fn on_event(
    &mut self,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    renderer: &Renderer,
    clipboard: &mut dyn Clipboard,
    shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

fn draw(
    &self,
    renderer: &mut Renderer,
    style: &Style,
    layout: Layout<'_>,
    cursor_position: Point,
    viewport: &Rectangle<f32>
)

Draws the Widget using the associated Renderer.

fn mouse_interaction(
    &self,
    layout: Layout<'_>,
    cursor_position: Point,
    viewport: &Rectangle<f32>,
    renderer: &Renderer
) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn overlay(
    &mut self,
    layout: Layout<'_>,
    renderer: &Renderer
) -> Option<Element<'_, Message, Renderer>>

Returns the overlay of the Widget, if there is any.