Struct iced_native::Shell

source ·
pub struct Shell<'a, Message> { /* private fields */ }
Expand description

A connection to the state of a shell.

A Widget can leverage a Shell to trigger changes in an application, like publishing messages or invalidating the current layout.

Implementations§

source§

impl<'a, Message> Shell<'a, Message>

source

pub fn new(messages: &'a mut Vec<Message>) -> Self

Creates a new Shell with the provided buffer of messages.

source

pub fn is_empty(&self) -> bool

Returns true if the Shell contains no published messages

source

pub fn publish(&mut self, message: Message)

Publish the given Message for an application to process it.

source

pub fn request_redraw(&mut self, request: RedrawRequest)

Requests a new frame to be drawn at the given [Instant].

source

pub fn redraw_request(&self) -> Option<RedrawRequest>

Returns the requested [Instant] a redraw should happen, if any.

source

pub fn is_layout_invalid(&self) -> bool

Returns whether the current layout is invalid or not.

source

pub fn invalidate_layout(&mut self)

Invalidates the current application layout.

The shell will relayout the application widgets.

source

pub fn revalidate_layout(&mut self, f: impl FnOnce())

Triggers the given function if the layout is invalid, cleaning it in the process.

source

pub fn are_widgets_invalid(&self) -> bool

Returns whether the widgets of the current application have been invalidated.

source

pub fn invalidate_widgets(&mut self)

Invalidates the current application widgets.

The shell will rebuild and relayout the widget tree.

source

pub fn merge<B>(&mut self, other: Shell<'_, B>, f: impl Fn(B) -> Message)

Merges the current Shell with another one by applying the given function to the messages of the latter.

This method is useful for composition.

Trait Implementations§

source§

impl<'a, Message: Debug> Debug for Shell<'a, Message>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, Message> RefUnwindSafe for Shell<'a, Message>where
    Message: RefUnwindSafe,

§

impl<'a, Message> Send for Shell<'a, Message>where
    Message: Send,

§

impl<'a, Message> Sync for Shell<'a, Message>where
    Message: Sync,

§

impl<'a, Message> Unpin for Shell<'a, Message>

§

impl<'a, Message> !UnwindSafe for Shell<'a, Message>

Blanket Implementations§

source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
    T: FloatComponent,
    Swp: WhitePoint,
    Dwp: WhitePoint,
    D: AdaptFrom<S, Swp, Dwp, T>,

source§

fn adapt_into_using<M>(self, method: M) -> Dwhere
    M: TransformMatrix<Swp, Dwp, T>,

Convert the source color to the destination color using the specified method
source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default
source§

impl<T> Any for Twhere
    T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
    U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> IntoColor<U> for Twhere
    U: FromColor<T>,

source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
source§

impl<T, U> IntoColorUnclamped<U> for Twhere
    U: FromColorUnclamped<T>,

source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
source§

impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T, U> TryIntoColor<U> for Twhere
    U: TryFromColor<T>,

source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
§

impl<V, T> VZip<V> for Twhere
    V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> MaybeSend for Twhere
    T: Send,