mirror of
https://github.com/encounter/rust-sdl2.git
synced 2026-07-10 21:18:41 -07:00
93 lines
35 KiB
HTML
93 lines
35 KiB
HTML
|
|
<!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 `EventSubsystem` struct in crate `sdl2`."><meta name="keywords" content="rust, rustlang, rust-lang, EventSubsystem"><title>sdl2::EventSubsystem - 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='../sdl2/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Struct EventSubsystem</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.event_sender">event_sender</a><a href="#method.flush_event">flush_event</a><a href="#method.flush_events">flush_events</a><a href="#method.peek_events">peek_events</a><a href="#method.push_custom_event">push_custom_event</a><a href="#method.push_event">push_event</a><a href="#method.register_custom_event">register_custom_event</a><a href="#method.register_event">register_event</a><a href="#method.register_events">register_events</a><a href="#method.sdl">sdl</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Sync">Sync</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-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-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</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'>sdl2</a></p><script>window.sidebarCurrent = {name: 'EventSubsystem', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled 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/sdl2/sdl.rs.html#199-203' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='inde
|
|||
|
|
</div><h4 id='method.flush_events' class="method"><code id='flush_events.v'>pub fn <a href='#method.flush_events' class='fnname'>flush_events</a>(&self, min_type: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, max_type: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code><a class='srclink' href='../src/sdl2/event.rs.html#58-60' title='goto source code'>[src]</a></h4><div class='docblock'><p>Removes all events in the event queue that match the specified type range.</p>
|
|||
|
|
</div><h4 id='method.peek_events' class="method"><code id='peek_events.v'>pub fn <a href='#method.peek_events' class='fnname'>peek_events</a><B>(&self, max_amount: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> B <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html" title="trait core::iter::traits::collect::FromIterator">FromIterator</a><<a class="enum" href="../sdl2/event/enum.Event.html" title="enum sdl2::event::Event">Event</a>>, </span></code><a class='srclink' href='../src/sdl2/event.rs.html#82-111' title='goto source code'>[src]</a></h4><div class='docblock'><p>Reads the events at the front of the event queue, until the maximum amount
|
|||
|
|
of events is read.</p>
|
|||
|
|
<p>The events will <em>not</em> be removed from the queue.</p>
|
|||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">sdl2</span>::<span class="ident">event</span>::<span class="ident">Event</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">sdl_context</span> <span class="op">=</span> <span class="ident">sdl2</span>::<span class="ident">init</span>().<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">event_subsystem</span> <span class="op">=</span> <span class="ident">sdl_context</span>.<span class="ident">event</span>().<span class="ident">unwrap</span>();
|
|||
|
|
|
|||
|
|
<span class="comment">// Read up to 1024 events</span>
|
|||
|
|
<span class="kw">let</span> <span class="ident">events</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">Event</span><span class="op">></span> <span class="op">=</span> <span class="ident">event_subsystem</span>.<span class="ident">peek_events</span>(<span class="number">1024</span>);
|
|||
|
|
|
|||
|
|
<span class="comment">// Print each one</span>
|
|||
|
|
<span class="kw">for</span> <span class="ident">event</span> <span class="kw">in</span> <span class="ident">events</span> {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">event</span>);
|
|||
|
|
}</pre></div>
|
|||
|
|
</div><h4 id='method.push_event' class="method"><code id='push_event.v'>pub fn <a href='#method.push_event' class='fnname'>push_event</a>(&self, event: <a class="enum" href="../sdl2/event/enum.Event.html" title="enum sdl2::event::Event">Event</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../src/sdl2/event.rs.html#114-116' title='goto source code'>[src]</a></h4><div class='docblock'><p>Pushes an event to the event queue.</p>
|
|||
|
|
</div><h4 id='method.register_event' class="method"><code id='register_event.v'>pub unsafe fn <a href='#method.register_event' class='fnname'>register_event</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../src/sdl2/event.rs.html#147-149' title='goto source code'>[src]</a></h4><div class='docblock'><p>Register a custom SDL event.</p>
|
|||
|
|
<p>When pushing a user event, you must make sure that the <code>type_</code> field is set to a
|
|||
|
|
registered SDL event number.</p>
|
|||
|
|
<p>The <code>code</code>, <code>data1</code>, and <code>data2</code> fields can be used to store user defined data.</p>
|
|||
|
|
<p>See the <a href="https://wiki.libsdl.org/SDL_UserEvent">SDL documentation</a> for more information.</p>
|
|||
|
|
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">sdl</span> <span class="op">=</span> <span class="ident">sdl2</span>::<span class="ident">init</span>().<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">ev</span> <span class="op">=</span> <span class="ident">sdl</span>.<span class="ident">event</span>().<span class="ident">unwrap</span>();
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">custom_event_type_id</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">ev</span>.<span class="ident">register_event</span>().<span class="ident">unwrap</span>() };
|
|||
|
|
<span class="kw">let</span> <span class="ident">event</span> <span class="op">=</span> <span class="ident">sdl2</span>::<span class="ident">event</span>::<span class="ident">Event</span>::<span class="ident">User</span> {
|
|||
|
|
<span class="ident">timestamp</span>: <span class="number">0</span>,
|
|||
|
|
<span class="ident">window_id</span>: <span class="number">0</span>,
|
|||
|
|
<span class="ident">type_</span>: <span class="ident">custom_event_type_id</span>,
|
|||
|
|
<span class="ident">code</span>: <span class="number">456</span>,
|
|||
|
|
<span class="ident">data1</span>: <span class="number">0x1234</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">libc</span>::<span class="ident">c_void</span>,
|
|||
|
|
<span class="ident">data2</span>: <span class="number">0x5678</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">libc</span>::<span class="ident">c_void</span>,
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
<span class="ident">ev</span>.<span class="ident">push_event</span>(<span class="ident">event</span>);
|
|||
|
|
</pre></div>
|
|||
|
|
</div><h4 id='method.register_events' class="method"><code id='register_events.v'>pub unsafe fn <a href='#method.register_events' class='fnname'>register_events</a>(&self, nr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../src/sdl2/event.rs.html#154-168' title='goto source code'>[src]</a></h4><div class='docblock'><p>Registers custom SDL events.</p>
|
|||
|
|
<p>Returns an error, if no more user events can be created.</p>
|
|||
|
|
</div><h4 id='method.register_custom_event' class="method"><code id='register_custom_event.v'>pub fn <a href='#method.register_custom_event' class='fnname'>register_custom_event</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../src/sdl2/event.rs.html#177-194' title='goto source code'>[src]</a></h4><div class='docblock'><p>Register a custom event</p>
|
|||
|
|
<p>It returns an error when the same type is registered twice.</p>
|
|||
|
|
<h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
|
|||
|
|
<p>See <a href="#method.push_custom_event">push_custom_event</a></p>
|
|||
|
|
</div><h4 id='method.push_custom_event' class="method"><code id='push_custom_event.v'>pub fn <a href='#method.push_custom_event' class='fnname'>push_custom_event</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>>(&self, event: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../src/sdl2/event.rs.html#224-227' title='goto source code'>[src]</a></h4><div class='docblock'><p>Push a custom event</p>
|
|||
|
|
<p>If the event type <code>T</code> was not registered using
|
|||
|
|
<a href="#method.register_custom_event">register_custom_event</a>,
|
|||
|
|
this method will panic.</p>
|
|||
|
|
<h1 id="example-pushing-and-receiving-a-custom-event" class="section-header"><a href="#example-pushing-and-receiving-a-custom-event">Example: pushing and receiving a custom event</a></h1>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">struct</span> <span class="ident">SomeCustomEvent</span> {
|
|||
|
|
<span class="ident">a</span>: <span class="ident">i32</span>
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">sdl</span> <span class="op">=</span> <span class="ident">sdl2</span>::<span class="ident">init</span>().<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">ev</span> <span class="op">=</span> <span class="ident">sdl</span>.<span class="ident">event</span>().<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">ep</span> <span class="op">=</span> <span class="ident">sdl</span>.<span class="ident">event_pump</span>().<span class="ident">unwrap</span>();
|
|||
|
|
|
|||
|
|
<span class="ident">ev</span>.<span class="ident">register_custom_event</span>::<span class="op"><</span><span class="ident">SomeCustomEvent</span><span class="op">></span>().<span class="ident">unwrap</span>();
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">event</span> <span class="op">=</span> <span class="ident">SomeCustomEvent</span> { <span class="ident">a</span>: <span class="number">42</span> };
|
|||
|
|
|
|||
|
|
<span class="ident">ev</span>.<span class="ident">push_custom_event</span>(<span class="ident">event</span>);
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">received</span> <span class="op">=</span> <span class="ident">ep</span>.<span class="ident">poll_event</span>().<span class="ident">unwrap</span>(); <span class="comment">// or within a for event in ep.poll_iter()</span>
|
|||
|
|
<span class="kw">if</span> <span class="ident">received</span>.<span class="ident">is_user_event</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">e2</span> <span class="op">=</span> <span class="ident">received</span>.<span class="ident">as_user_event_type</span>::<span class="op"><</span><span class="ident">SomeCustomEvent</span><span class="op">></span>().<span class="ident">unwrap</span>();
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e2</span>.<span class="ident">a</span>, <span class="number">42</span>);
|
|||
|
|
}</pre></div>
|
|||
|
|
</div><h4 id='method.event_sender' class="method"><code id='event_sender.v'>pub fn <a href='#method.event_sender' class='fnname'>event_sender</a>(&self) -> <a class="struct" href="../sdl2/event/struct.EventSender.html" title="struct sdl2::event::EventSender">EventSender</a></code><a class='srclink' href='../src/sdl2/event.rs.html#233-237' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create an event sender that can be sent to other threads.</p>
|
|||
|
|
<p>An <code>EventSender</code> will not keep the event subsystem alive. If the event subsystem is
|
|||
|
|
shut down calls to <code>push_event</code> and <code>push_custom_event</code> will return errors.</p>
|
|||
|
|
</div></div><h3 id='impl-1' class='impl'><code class='in-band'>impl <a class="struct" href="../sdl2/struct.EventSubsystem.html" title="struct sdl2::EventSubsystem">EventSubsystem</a></code><a href='#impl-1' class='anchor'></a><a class='srclink' href='../src/sdl2/sdl.rs.html#215-221' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.sdl' class="method"><code id='sdl.v'>pub fn <a href='#method.sdl' class='fnname'>sdl</a>(&self) -> <a class="struct" href="../sdl2/struct.Sdl.html" title="struct sdl2::Sdl">Sdl</a></code><a class='srclink' href='../src/sdl2/sdl.rs.html#218-220' title='goto source code'>[src]</a></h4><div class='docblock'><p>Obtain an SDL context.</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-Clone' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../sdl2/struct.EventSubsystem.html" title="struct sdl2::EventSubsystem">EventSubsystem</a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../src/sdl2/sdl.rs.html#206-213' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../sdl2/struct.EventSubsystem.html" title="struct sdl2::EventSubsystem">EventSubsystem</a></code><a class='srclink' href='../src/sdl2/sdl.rs.html#208-212' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
|||
|
|
</div></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="../sdl2/struct.EventSubsystem.html" title="struct sdl2::EventSubsystem">EventSubsystem</a></code><a href='#impl-Sync' class='anchor'></a><a class='srclink' href='../src/sdl2/sdl.rs.html#204' title='goto source code'>[src]</a></h3><div class='impl-items'></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-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="../sdl2/struct.EventSubsystem.html" title="struct sdl2::EventSubsystem">EventSubsystem</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><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="../sdl2/struct.EventSubsystem.html" title="struct sdl2::EventSubsystem">EventSubsystem</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="../sdl2/struct.EventSubsystem.html" title="struct sdl2::EventSubsystem">EventSubsystem</a></code><a href='#impl-Unpin' 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="../sdl2/struct.EventSubsystem.html" title="struct sdl2::EventSubsystem">EventSubsystem</a></code><a href='#impl-UnwindSafe' 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-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#108-112' 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#109-111' 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-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-217' 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-216' 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-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#220-224' 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#221-223' 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-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/mod.rs.html#565-569' 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/mod.rs.html#566-568' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><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/mod.rs.html#554-561' 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/mod.rs.html#558-560' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-ToOwned' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#80-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
|||
|
|
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&self) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&self, target: <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/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
|||
|
|
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></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/mod.rs.html#602-611' 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/mod.rs.html#608-610' 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/mod.rs.html#588-597' 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/mod.rs.html#594-596' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|||
|
|
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "sdl2";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|