|
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `EventsLoop` struct in crate `winit`."><meta name="keywords" content="rust, rustlang, rust-lang, EventsLoop"><title>winit::EventsLoop - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../winit/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Struct EventsLoop</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.create_proxy">create_proxy</a><a href="#method.get_available_monitors">get_available_monitors</a><a href="#method.get_primary_monitor">get_primary_monitor</a><a href="#method.new">new</a><a href="#method.poll_events">poll_events</a><a href="#method.run_forever">run_forever</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-EventsLoopExt">EventsLoopExt</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-Erased">Erased</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='index.html'>winit</a></p><script>window.sidebarCurrent = {name: 'EventsLoop', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/winit/lib.rs.html#218-221' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='index.html'>winit</a>::<wbr><a class="struct" href=''>EventsLoop</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct EventsLoop { /* fields omitted */ }</pre></div><div class='docblock'><p>Provides a way to retrieve events from the system and from the windows that were registered to
|
|
|
the events loop.</p>
|
|
|
<p>An <code>EventsLoop</code> can be seen more or less as a "context". Calling <code>EventsLoop::new()</code>
|
|
|
initializes everything that will be required to create windows. For example on Linux creating
|
|
|
an events loop opens a connection to the X or Wayland server.</p>
|
|
|
<p>To wake up an <code>EventsLoop</code> from a another thread, see the <code>EventsLoopProxy</code> docs.</p>
|
|
|
<p>Note that the <code>EventsLoop</code> cannot be shared accross threads (due to platform-dependant logic
|
|
|
forbiding it), as such it is neither <code>Send</code> nor <code>Sync</code>. If you need cross-thread access, the
|
|
|
<code>Window</code> created from this <code>EventsLoop</code> <em>can</em> be sent to an other thread, and the
|
|
|
<code>EventsLoopProxy</code> allows you to wakeup an <code>EventsLoop</code> from an other thread.</p>
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../winit/struct.EventsLoop.html" title="struct winit::EventsLoop">EventsLoop</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/winit/lib.rs.html#241-301' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../winit/struct.EventsLoop.html" title="struct winit::EventsLoop">EventsLoop</a></code><a class='srclink' href='../src/winit/lib.rs.html#248-253' title='goto source code'>[src]</a></h4><div class='docblock'><p>Builds a new events loop.</p>
|
|
|
<p>Usage will result in display backend initialisation, this can be controlled on linux
|
|
|
using an environment variable <code>WINIT_UNIX_BACKEND</code>. Legal values are <code>x11</code> and <code>wayland</code>.
|
|
|
If it is not set, winit will try to connect to a wayland connection, and if it fails will
|
|
|
fallback on x11. If this variable is set with any other value, winit will panic.</p>
|
|
|
</div><h4 id='method.get_available_monitors' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../winit/struct.AvailableMonitorsIter.html" title="struct winit::AvailableMonitorsIter">AvailableMonitorsIter</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../winit/struct.AvailableMonitorsIter.html" title="struct winit::AvailableMonitorsIter">AvailableMonitorsIter</a></h3><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../winit/struct.AvailableMonitorsIter.html" title="struct winit::AvailableMonitorsIter">AvailableMonitorsIter</a></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="struct" href="../winit/struct.MonitorId.html" title="struct winit::MonitorId">MonitorId</a>;</span></code></div></div><code id='get_available_monitors.v'>pub fn <a href='#method.get_available_monitors' class='fnname'>get_available_monitors</a>(&self) -> <a class="struct" href="../winit/struct.AvailableMonitorsIter.html" title="struct winit::AvailableMonitorsIter">AvailableMonitorsIter</a></code><a class='srclink' href='../src/winit/lib.rs.html#259-262' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the list of all the monitors available on the system.</p>
|
|
|
</div><h4 id='method.get_primary_monitor' class="method"><code id='get_primary_monitor.v'>pub fn <a href='#method.get_primary_monitor' class='fnname'>get_primary_monitor</a>(&self) -> <a class="struct" href="../winit/struct.MonitorId.html" title="struct winit::MonitorId">MonitorId</a></code><a class='srclink' href='../src/winit/lib.rs.html#266-268' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the primary monitor of the system.</p>
|
|
|
</div><h4 id='method.poll_events' class="method"><code id='poll_events.v'>pub fn <a href='#method.poll_events' class='fnname'>poll_events</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="../winit/enum.Event.html" title="enum winit::Event">Event</a>), </span></code><a class='srclink' href='../src/winit/lib.rs.html#273-277' title='goto source code'>[src]</a></h4><div class='docblock'><p>Fetches all the events that are pending, calls the callback function for each of them,
|
|
|
and returns.</p>
|
|
|
</div><h4 id='method.run_forever' class="method"><code id='run_forever.v'>pub fn <a href='#method.run_forever' class='fnname'>run_forever</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="../winit/enum.Event.html" title="enum winit::Event">Event</a>) -> <a class="enum" href="../winit/enum.ControlFlow.html" title="enum winit::ControlFlow">ControlFlow</a>, </span></code><a class='srclink' href='../src/winit/lib.rs.html#288-292' title='goto source code'>[src]</a></h4><div class='docblock'><p>Calls <code>callback</code> every time an event is received. If no event is available, sleeps the
|
|
|
current thread and waits for an event. If the callback returns <code>ControlFlow::Break</code> then
|
|
|
<code>run_forever</code> will immediately return.</p>
|
|
|
<h1 id="danger" class="section-header"><a href="#danger">Danger!</a></h1>
|
|
|
<p>The callback is run after <em>every</em> event, so if its execution time is non-trivial the event queue may not empty
|
|
|
at a sufficient rate. Rendering in the callback with vsync enabled <strong>will</strong> cause significant lag.</p>
|
|
|
</div><h4 id='method.create_proxy' class="method"><code id='create_proxy.v'>pub fn <a href='#method.create_proxy' class='fnname'>create_proxy</a>(&self) -> <a class="struct" href="../winit/struct.EventsLoopProxy.html" title="struct winit::EventsLoopProxy">EventsLoopProxy</a></code><a class='srclink' href='../src/winit/lib.rs.html#296-300' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates an <code>EventsLoopProxy</code> that can be used to wake up the <code>EventsLoop</code> from another
|
|
|
thread.</p>
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-EventsLoopExt' class='impl'><code class='in-band'>impl <a class="trait" href="../winit/os/unix/trait.EventsLoopExt.html" title="trait winit::os::unix::EventsLoopExt">EventsLoopExt</a> for <a class="struct" href="../winit/struct.EventsLoop.html" title="struct winit::EventsLoop">EventsLoop</a></code><a href='#impl-EventsLoopExt' class='anchor'></a><a class='srclink' href='../src/winit/os/unix.rs.html#125-170' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new_x11' class="method hidden"><code id='new_x11.v'>fn <a href='../winit/os/unix/trait.EventsLoopExt.html#tymethod.new_x11' class='fnname'>new_x11</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="enum" href="../winit/os/unix/enum.XNotSupported.html" title="enum winit::os::unix::XNotSupported">XNotSupported</a>></code><a class='srclink' href='../src/winit/os/unix.rs.html#127-134' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Builds a new <code>EventsLoop</code> that is forced to use X11.</p>
|
|
|
</div><h4 id='method.new_wayland' class="method hidden"><code id='new_wayland.v'>fn <a href='../winit/os/unix/trait.EventsLoopExt.html#tymethod.new_wayland' class='fnname'>new_wayland</a>() -> Self</code><a class='srclink' href='../src/winit/os/unix.rs.html#137-145' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Builds a new <code>EventsLoop</code> that is forced to use Wayland.</p>
|
|
|
</div><h4 id='method.is_wayland' class="method hidden"><code id='is_wayland.v'>fn <a href='../winit/os/unix/trait.EventsLoopExt.html#tymethod.is_wayland' class='fnname'>is_wayland</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/winit/os/unix.rs.html#148-150' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>True if the <code>EventsLoop</code> uses Wayland.</p>
|
|
|
</div><h4 id='method.is_x11' class="method hidden"><code id='is_x11.v'>fn <a href='../winit/os/unix/trait.EventsLoopExt.html#tymethod.is_x11' class='fnname'>is_x11</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/winit/os/unix.rs.html#153-155' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>True if the <code>EventsLoop</code> uses X11.</p>
|
|
|
</div><h4 id='method.get_wayland_display' class="method hidden"><code id='get_wayland_display.v'>fn <a href='../winit/os/unix/trait.EventsLoopExt.html#tymethod.get_wayland_display' class='fnname'>get_wayland_display</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>></code><a class='srclink' href='../src/winit/os/unix.rs.html#164-169' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a pointer to the <code>wl_display</code> object of wayland that is used by this <code>EventsLoop</code>. <a href="../winit/os/unix/trait.EventsLoopExt.html#tymethod.get_wayland_display">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../winit/struct.EventsLoop.html" title="struct winit::EventsLoop">EventsLoop</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../src/winit/lib.rs.html#223-227' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmtr: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../src/winit/lib.rs.html#224-226' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|
|
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../winit/struct.EventsLoop.html" title="struct winit::EventsLoop">EventsLoop</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../winit/struct.EventsLoop.html" title="struct winit::EventsLoop">EventsLoop</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../winit/struct.EventsLoop.html" title="struct winit::EventsLoop">EventsLoop</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../winit/struct.EventsLoop.html" title="struct winit::EventsLoop">EventsLoop</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../winit/struct.EventsLoop.html" title="struct winit::EventsLoop">EventsLoop</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Erased' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../owning_ref/trait.Erased.html" title="trait owning_ref::Erased">Erased</a> for T</code><a href='#impl-Erased' class='anchor'></a><a class='srclink' href='../src/owning_ref/lib.rs.html#281' title='goto source code'>[src]</a></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "winit";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
