Struct 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 capture_event(&mut self)

Marks the current event as captured. Prevents “event bubbling”.

A widget should capture an event when no ancestor should handle it.

Source

pub fn event_status(&self) -> Status

Returns the current event::Status of the Shell.

Source

pub fn is_event_captured(&self) -> bool

Returns whether the current event has been captured.

Source

pub fn request_redraw(&mut self)

Requests a new frame to be drawn as soon as possible.

Source

pub fn request_redraw_at(&mut self, redraw_request: impl Into<RedrawRequest>)

Requests a new frame to be drawn at the given window::RedrawRequest.

Source

pub fn redraw_request(&self) -> RedrawRequest

Returns the request a redraw should happen, if any.

Source

pub fn replace_redraw_request(shell: &mut Self, redraw_request: RedrawRequest)

Replaces the redraw request of the Shell; without conflict resolution.

This is useful if you want to overwrite the redraw request to a previous value. Since it’s a fairly advanced use case and should rarely be used, it is a static method.

Source

pub fn request_input_method<T: AsRef<str>>(&mut self, ime: &InputMethod<T>)

Requests the current InputMethod strategy.

Important: This request will only be honored by the Shell only during a window::Event::RedrawRequested.

Source

pub fn input_method(&self) -> &InputMethod

Returns the current InputMethod strategy.

Source

pub fn input_method_mut(&mut self) -> &mut InputMethod

Returns the current InputMethod strategy.

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> Freeze for Shell<'a, Message>

§

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<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T