summaryrefslogtreecommitdiffstats
path: root/winit/src/proxy.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-28 02:49:32 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-28 02:49:32 +0200
commitef28347f1c816d8ad9e772303467de489efb802b (patch)
tree78a06298839f1311a40a7655724fc7ec1322c730 /winit/src/proxy.rs
parent508128436c5da88d4b4f384a9fe73288320eb9ec (diff)
downloadiced-ef28347f1c816d8ad9e772303467de489efb802b.tar.gz
iced-ef28347f1c816d8ad9e772303467de489efb802b.tar.bz2
iced-ef28347f1c816d8ad9e772303467de489efb802b.zip
Write documentation for new `iced_winit` API
Diffstat (limited to '')
-rw-r--r--winit/src/proxy.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/winit/src/proxy.rs b/winit/src/proxy.rs
index ee96614a..532f8c56 100644
--- a/winit/src/proxy.rs
+++ b/winit/src/proxy.rs
@@ -5,6 +5,7 @@ use iced_native::futures::{
};
use std::pin::Pin;
+/// An event loop proxy that implements `Sink`.
#[derive(Debug)]
pub struct Proxy<Message: 'static> {
raw: winit::event_loop::EventLoopProxy<Message>,
@@ -19,6 +20,9 @@ impl<Message: 'static> Clone for Proxy<Message> {
}
impl<Message: 'static> Proxy<Message> {
+ /// Creates a new [`Proxy`] from an `EventLoopProxy`.
+ ///
+ /// [`Proxy`]: struct.Proxy.html
pub fn new(raw: winit::event_loop::EventLoopProxy<Message>) -> Self {
Self { raw }
}