pub struct LaunchBuilder<Cfg: 'static = (), ContextFn: ?Sized = dyn Fn() -> Box<dyn Any> + 'static> { /* private fields */ }
Available on crate feature launch only.
Expand description

A builder for a fullstack app.

Implementations§

source§

impl LaunchBuilder

source

pub fn new() -> LaunchBuilder<(), dyn Fn() -> Box<dyn Any> + 'static>

Create a new builder for your application. This will create a launch configuration for the current platform based on the features enabled on the dioxus crate.

source

pub fn custom<Cfg, List>( launch_fn: LaunchFn<Cfg, List> ) -> LaunchBuilder<Cfg, List>

Provide a custom launch function for your application.

Useful for third party renderers to tap into the launch builder API without having to reimplement it.

source§

impl<Cfg> LaunchBuilder<Cfg, dyn Fn() -> Box<dyn Any> + 'static>

source

pub fn with_context_provider( self, state: impl Fn() -> Box<dyn Any> + 'static ) -> Self

Inject state into the root component’s context that is created on the thread that the app is launched on.

source

pub fn with_context(self, state: impl Any + Clone + 'static) -> Self

Inject state into the root component’s context.

source§

impl<Cfg> LaunchBuilder<Cfg, dyn Fn() -> Box<dyn Any> + Send + Sync + 'static>

source

pub fn with_context_provider( self, state: impl Fn() -> Box<dyn Any> + Send + Sync + 'static ) -> Self

Inject state into the root component’s context that is created on the thread that the app is launched on.

source

pub fn with_context( self, state: impl Any + Clone + Send + Sync + 'static ) -> Self

Inject state into the root component’s context.

source§

impl<Cfg: Default + 'static, ContextFn: ?Sized> LaunchBuilder<Cfg, ContextFn>

source

pub fn with_cfg(self, config: impl TryIntoConfig<Cfg>) -> Self

Provide a platform-specific config to the builder.

source

pub fn launch(self, app: fn() -> Element)

Launch your application.

Auto Trait Implementations§

§

impl<Cfg, ContextFn: ?Sized> Freeze for LaunchBuilder<Cfg, ContextFn>
where Cfg: Freeze,

§

impl<Cfg, ContextFn: ?Sized> RefUnwindSafe for LaunchBuilder<Cfg, ContextFn>
where Cfg: RefUnwindSafe, ContextFn: RefUnwindSafe,

§

impl<Cfg, ContextFn: ?Sized> Send for LaunchBuilder<Cfg, ContextFn>
where Cfg: Send, ContextFn: Send,

§

impl<Cfg, ContextFn: ?Sized> Sync for LaunchBuilder<Cfg, ContextFn>
where Cfg: Sync, ContextFn: Sync,

§

impl<Cfg, ContextFn: ?Sized> Unpin for LaunchBuilder<Cfg, ContextFn>
where Cfg: Unpin,

§

impl<Cfg, ContextFn: ?Sized> UnwindSafe for LaunchBuilder<Cfg, ContextFn>
where Cfg: UnwindSafe, ContextFn: UnwindSafe,

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.

source§

impl<T> Instrument for T

source§

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

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

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, O> SuperFrom<T> for O
where O: From<T>,

source§

fn super_from(input: T) -> O

Convert from a type to another type.
source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

source§

fn super_into(self) -> O

Convert from a type to another type.
source§

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

source§

fn to<T>(self) -> T
where Self: Into<T>,

Converts to T by calling Into<T>::into.
source§

fn try_to<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.
source§

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

§

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>,

§

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.
source§

impl<Cfg> TryIntoConfig for Cfg

source§

fn into_config(self) -> Option<Cfg>

Available on crate feature launch only.
source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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