Struct DioxusPlugin

Source
pub struct DioxusPlugin<GlobalState, CoreCommand, UiCommand, Props = ()> {
    pub Root: Component<Props>,
    /* private fields */
}
Expand description

Dioxus Plugin for Bevy

Fields§

§Root: Component<Props>

Root component

Implementations§

Source§

impl<GlobalState, CoreCommand, UiCommand, Props> DioxusPlugin<GlobalState, CoreCommand, UiCommand, Props>
where GlobalState: Send + Sync + GlobalStateHandler, CoreCommand: Clone + Debug + Send + Sync, UiCommand: Clone + Debug + Send + Sync, Props: Send + Sync + Clone + 'static,

Source

pub fn new(Root: DioxusComponent<Props>) -> Self

Initialize DioxusPlugin with root component and channel types

use bevy::prelude::*;
use bevy_dioxus::desktop::prelude::*;
use dioxus::prelude::*;

// DioxusPlugin accepts any types as command. Pass empty tuple if channel is not necessary.
type CoreCommand = ();
type UiCommand = ();

fn main() {
   App::new()
        .add_plugin(DioxusPlugin::<EmptyGlobalState, CoreCommand, UiCommand>::new(Root))
        .run();
}

fn Root(cx: Scope) -> Element {
   cx.render(rsx! {
   h1 { "Hello, World !" }
       })
}

Trait Implementations§

Source§

impl<GlobalState, CoreCommand, UiCommand, Props> Plugin for DioxusPlugin<GlobalState, CoreCommand, UiCommand, Props>
where GlobalState: 'static + Send + Sync + GlobalStateHandler, CoreCommand: 'static + Send + Sync + Clone + Debug, UiCommand: 'static + Send + Sync + Clone + Debug, Props: 'static + Send + Sync + Clone + Default,

Source§

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.
Source§

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for debugging.

Auto Trait Implementations§

§

impl<GlobalState, CoreCommand, UiCommand, Props> Freeze for DioxusPlugin<GlobalState, CoreCommand, UiCommand, Props>

§

impl<GlobalState, CoreCommand, UiCommand, Props> RefUnwindSafe for DioxusPlugin<GlobalState, CoreCommand, UiCommand, Props>
where GlobalState: RefUnwindSafe, CoreCommand: RefUnwindSafe, UiCommand: RefUnwindSafe,

§

impl<GlobalState, CoreCommand, UiCommand, Props> Send for DioxusPlugin<GlobalState, CoreCommand, UiCommand, Props>
where GlobalState: Send, CoreCommand: Send, UiCommand: Send,

§

impl<GlobalState, CoreCommand, UiCommand, Props> Sync for DioxusPlugin<GlobalState, CoreCommand, UiCommand, Props>
where GlobalState: Sync, CoreCommand: Sync, UiCommand: Sync,

§

impl<GlobalState, CoreCommand, UiCommand, Props> Unpin for DioxusPlugin<GlobalState, CoreCommand, UiCommand, Props>
where GlobalState: Unpin, CoreCommand: Unpin, UiCommand: Unpin,

§

impl<GlobalState, CoreCommand, UiCommand, Props> UnwindSafe for DioxusPlugin<GlobalState, CoreCommand, UiCommand, Props>
where GlobalState: UnwindSafe, CoreCommand: UnwindSafe, UiCommand: 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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

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

Source§

fn vzip(self) -> V

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

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

Source§

impl<T> MaybeSendSync for T

Source§

impl<T> Resource for T
where T: Send + Sync + 'static,