Struct winit::event_loop::EventLoopBuilder

source ·
pub struct EventLoopBuilder<T: 'static> {
    pub(crate) platform_specific: PlatformSpecificEventLoopAttributes,
    _p: PhantomData<T>,
}
Expand description

Object that allows building the event loop.

This is used to make specifying options that affect the whole application easier. But note that constructing multiple event loops is not supported.

This can be created using EventLoop::new or EventLoop::with_user_event.

Fields§

§platform_specific: PlatformSpecificEventLoopAttributes§_p: PhantomData<T>

Implementations§

source§

impl EventLoopBuilder<()>

source

pub fn new() -> Self

👎Deprecated: use EventLoop::builder instead

Start building a new event loop.

source§

impl<T> EventLoopBuilder<T>

source

pub fn build(&mut self) -> Result<EventLoop<T>, EventLoopError>

Builds a new event loop.

For cross-platform compatibility, the EventLoop must be created on the main thread, and only once per application.

Calling this function will result in display backend initialisation.

§Panics

Attempting to create the event loop off the main thread will panic. This restriction isn’t strictly necessary on all platforms, but is imposed to eliminate any nasty surprises when porting to platforms that require it. EventLoopBuilderExt::any_thread functions are exposed in the relevant platform module if the target platform supports creating an event loop on any thread.

§Platform-specific
  • Wayland/X11: to prevent running under Wayland or X11 unset WAYLAND_DISPLAY or DISPLAY respectively when building the event loop.
  • Android: must be configured with an AndroidApp from android_main() by calling .with_android_app(app) before calling .build(), otherwise it’ll panic.

Trait Implementations§

source§

impl<T: Default + 'static> Default for EventLoopBuilder<T>

source§

fn default() -> EventLoopBuilder<T>

Returns the “default value” for a type. Read more
source§

impl<T> EventLoopBuilderExtWayland for EventLoopBuilder<T>

source§

fn with_wayland(&mut self) -> &mut Self

Force using Wayland.
source§

fn with_any_thread(&mut self, any_thread: bool) -> &mut Self

Whether to allow the event loop to be created off of the main thread. Read more
source§

impl<T> EventLoopBuilderExtX11 for EventLoopBuilder<T>

source§

fn with_x11(&mut self) -> &mut Self

Force using X11.
source§

fn with_any_thread(&mut self, any_thread: bool) -> &mut Self

Whether to allow the event loop to be created off of the main thread. Read more

Auto Trait Implementations§

§

impl<T> Freeze for EventLoopBuilder<T>

§

impl<T> RefUnwindSafe for EventLoopBuilder<T>
where T: RefUnwindSafe,

§

impl<T> Send for EventLoopBuilder<T>
where T: Send,

§

impl<T> Sync for EventLoopBuilder<T>
where T: Sync,

§

impl<T> Unpin for EventLoopBuilder<T>
where T: Unpin,

§

impl<T> UnwindSafe for EventLoopBuilder<T>
where T: 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, 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<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