leyoda/winit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Formalize thread-safety guarantees (#322)

Browse source
This commit is contained in:
Victor Berger 2017-10-18 20:40:21 +02:00 • committed by tomaka
parent 48902297b7
commit 229029f2da
5 changed files with 40 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/lib.rs
View file

@ -167,8 +167,14 @@ pub struct DeviceId(platform::DeviceId);
/// an events loop opens a connection to the X or Wayland server.
///
/// To wake up an `EventsLoop` from a another thread, see the `EventsLoopProxy` docs.
///
/// Note that the `EventsLoop` cannot be shared accross threads (due to platform-dependant logic
/// forbiding it), as such it is neither `Send` nor `Sync`. If you need cross-thread access, the
/// `Window` created from this `EventsLoop` _can_ be sent to an other thread, and the
/// `EventsLoopProxy` allows you to wakeup an `EventsLoop` from an other thread.
pub struct EventsLoop {
events_loop: platform::EventsLoop,
_marker: ::std::marker::PhantomData<*mut ()> // Not Send nor Sync
}
/// Returned by the user callback given to the `EventsLoop::run_forever` method.
@ -192,6 +198,7 @@ impl EventsLoop {
pub fn new() -> EventsLoop {
EventsLoop {
events_loop: platform::EventsLoop::new(),
_marker: ::std::marker::PhantomData,
}
}