Struct FailurePanel 

pub struct FailurePanel { /* private fields */ }

A panel that states what went wrong instead of what it was going to show.

Implementations

impl FailurePanel

pub fn new(ident: impl Into<Ident>, reason: impl Into<SharedString>) -> Self

pub fn from_result<T, E: Display>( ident: impl Into<Ident>, result: &Result<T, E>, ) -> Option<Self>

The panel for a failure the host is already holding, or None when it is holding a value instead.

This is the seam the whole component exists for: the caller renders its content in the Ok arm and this in the Err arm, and the failure it shows is the one the host actually has rather than one this crate caught.

pub fn title(self, title: impl Into<SharedString>) -> Self

What the panel was going to be, so the reader knows which part of the window is missing rather than only that something is.

pub fn detail(self, detail: impl Into<SharedString>) -> Self

pub fn attempts(self, attempts: usize) -> Self

How many times this has been tried. A retry that keeps failing is a different fact from a first failure, and hiding the count would let a reader keep pressing a control that has never once worked.

pub fn retrying(self, retrying: bool) -> Self

Whether a retry is in flight. While it is, the failure stays on screen: nothing has replaced it yet.

pub fn on_retry(self, handler: impl Fn(&mut Window, &mut App) + 'static) -> Self

Reports that the typist asked for another attempt.

Retrying belongs to the host — this panel has no idea what produced the failure — so it reports and does nothing. A panel with no handler shows no retry control at all rather than a dead one.

Trait Implementations

impl Debug for FailurePanel

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

Formats the value using the given formatter.

impl IntoElement for FailurePanel

type Element = ViewElement<FailurePanel>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for FailurePanel

fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.