<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `SIM` struct in crate `headless`."><metaname="keywords"content="rust, rustlang, rust-lang, SIM"><title>headless::SIM - Rust</title><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><scriptsrc="../storage.js"></script><noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="shortcut icon"href="../favicon.ico"><styletype="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../headless/index.html'><divclass='logo-container rust-logo'><imgsrc='../rust-logo.png'alt='logo'></div></a><pclass='location'>Struct SIM</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#fields">Fields</a><divclass="sidebar-links"><ahref="#structfield.__private_field">__private_field</a></div><aclass="sidebar-title"href="#deref-methods">Methods from Deref<Target=RwLock<Sim>></a><divclass="sidebar-links"><ahref="#method.is_poisoned">is_poisoned</a><ahref="#method.read">read</a><ahref="#method.try_read">try_read</a><ahref="#method.try_write">try_write</a><ahref="#method.write">write</a></div><aclass="sidebar-title"href="#trait-implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Deref">Deref</a><ahref="#impl-LazyStatic">LazyStatic</a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-Downcast">Downcast</a><ahref="#impl-DowncastSync">DowncastSync</a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Instrument">Instrument</a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-Same%3CT%3E">Same<T></a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a><ahref="#impl-VZip%3CV%3E">VZip<V></a></div></div><pclass='location'><ahref='index.html'>headless</a></p><script>window.sidebarCurrent={name:'SIM',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../theme.js"></script><navclass="sub"><formclass="search-form"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"disabledautocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><spanclass="help-button">?</span>
</div><h4id='method.try_read'class="method"><code>pub fn <ahref='#method.try_read'class='fnname'>try_read</a>(<br> &self<br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/sync/rwlock/struct.RwLockReadGuard.html"title="struct std::sync::rwlock::RwLockReadGuard">RwLockReadGuard</a><'_, T>, <aclass="enum"href="https://doc.rust-lang.org/nightly/std/sys_common/poison/enum.TryLockError.html"title="enum std::sys_common::poison::TryLockError">TryLockError</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/sync/rwlock/struct.RwLockReadGuard.html"title="struct std::sync::rwlock::RwLockReadGuard">RwLockReadGuard</a><'_, T>>></code><spanclass='since'title='Stable since Rust version 1.0.0'>1.0.0</span><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/std/sync/rwlock.rs.html#216-224'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Attempts to acquire this rwlock with shared read access.</p>
</div><h4id='method.write'class="method"><code>pub fn <ahref='#method.write'class='fnname'>write</a>(<br> &self<br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/sync/rwlock/struct.RwLockWriteGuard.html"title="struct std::sync::rwlock::RwLockWriteGuard">RwLockWriteGuard</a><'_, T>, <aclass="struct"href="https://doc.rust-lang.org/nightly/std/sys_common/poison/struct.PoisonError.html"title="struct std::sys_common::poison::PoisonError">PoisonError</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/sync/rwlock/struct.RwLockWriteGuard.html"title="struct std::sync::rwlock::RwLockWriteGuard">RwLockWriteGuard</a><'_, T>>></code><spanclass='since'title='Stable since Rust version 1.0.0'>1.0.0</span><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/std/sync/rwlock.rs.html#259-264'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Locks this rwlock with exclusive write access, blocking the current
</div><h4id='method.try_write'class="method"><code>pub fn <ahref='#method.try_write'class='fnname'>try_write</a>(<br> &self<br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/sync/rwlock/struct.RwLockWriteGuard.html"title="struct std::sync::rwlock::RwLockWriteGuard">RwLockWriteGuard</a><'_, T>, <aclass="enum"href="https://doc.rust-lang.org/nightly/std/sys_common/poison/enum.TryLockError.html"title="enum std::sys_common::poison::TryLockError">TryLockError</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/std/sync/rwlock/struct.RwLockWriteGuard.html"title="struct std::sync::rwlock::RwLockWriteGuard">RwLockWriteGuard</a><'_, T>>></code><spanclass='since'title='Stable since Rust version 1.0.0'>1.0.0</span><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/std/sync/rwlock.rs.html#298-306'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Attempts to lock this rwlock with exclusive write access.</p>
</div><h4id='method.is_poisoned'class="method"><code>pub fn <ahref='#method.is_poisoned'class='fnname'>is_poisoned</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><spanclass='since'title='Stable since Rust version 1.2.0'>1.2.0</span><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/std/sync/rwlock.rs.html#331-333'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Determines whether the lock is poisoned.</p>
</div></div><h3id='impl-Downcast'class='impl'><codeclass='in-band'>impl<T> Downcast for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a>, </span></code><ahref='#impl-Downcast'class='anchor'></a></h3><divclass='impl-items'><h4id='method.into_any'class="method hidden"><code>fn <ahref='#method.into_any'class='fnname'>into_any</a>(self: <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html"title="struct alloc::boxed::Box">Box</a><T>) -><aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html"title="struct alloc::boxed::Box">Box</a><dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> + 'static></code></h4><divclass='docblock hidden'><p>Convert <code>Box<dyn Trait></code> (where <code>Trait: Downcast</code>) to <code>Box<dyn Any></code>. <code>Box<dyn Any></code> can then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any">Read more</a></p>
</div><h4id='method.into_any_rc'class="method hidden"><code>fn <ahref='#method.into_any_rc'class='fnname'>into_any_rc</a>(self: <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html"title="struct alloc::rc::Rc">Rc</a><T>) -><aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html"title="struct alloc::rc::Rc">Rc</a><dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> + 'static></code></h4><divclass='docblock hidden'><p>Convert <code>Rc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Rc<Any></code>. <code>Rc<Any></code> can then be further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any_rc">Read more</a></p>
</div><h4id='method.as_any'class="method hidden"><code>fn <ahref='#method.as_any'class='fnname'>as_any</a>(&self) ->&(dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> + 'static)</code></h4><divclass='docblock hidden'><p>Convert <code>&Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot generate <code>&Any</code>'s vtable from <code>&Trait</code>'s. <ahref="#tymethod.as_any">Read more</a></p>
</div><h4id='method.as_any_mut'class="method hidden"><code>fn <ahref='#method.as_any_mut'class='fnname'>as_any_mut</a>(&mut self) ->&mut (dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> + 'static)</code></h4><divclass='docblock hidden'><p>Convert <code>&mut Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot generate <code>&mut Any</code>'s vtable from <code>&mut Trait</code>'s. <ahref="#tymethod.as_any_mut">Read more</a></p>
</div></div><h3id='impl-Instrument'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</code><ahref='#impl-Instrument'class='anchor'></a><aclass='srclink'href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#155'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.instrument'class="method hidden"><code>fn <ahref='https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.instrument'class='fnname'>instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.21/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.21/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><aclass='srclink'href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#38-40'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an <code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
</div><h4id='method.in_current_span'class="method hidden"><code>fn <ahref='https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.in_current_span'class='fnname'>in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.21/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><aclass='srclink'href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#74-76'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the [current] <code>Span</code>, returning an <code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
</div></div><h3id='impl-Instrument-1'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html"title="trait tracing_futures::Instrument">Instrument</a> for T</code><ahref='#impl-Instrument-1'class='anchor'></a><aclass='srclink'href='https://docs.rs/tracing-futures/0.2.3/src/tracing_futures/lib.rs.html#248'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.instrument-1'class="method hidden"><code>fn <ahref='https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.instrument'class='fnname'>instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.21/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/struct.Instrumented.html"title="struct tracing_futures::Instrumented">Instrumented</a><Self></code><aclass='srclink'href='https://docs.rs/tracing-futures/0.2.3/src/tracing_futures/lib.rs.html#129-131'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an <code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.instrument">Read more</a></p>
</div><h4id='method.in_current_span-1'class="method hidden"><code>fn <ahref='https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.in_current_span'class='fnname'>in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/struct.Instrumented.html"title="struct tracing_futures::Instrumented">Instrumented</a><Self></code><aclass='srclink'href='https://docs.rs/tracing-futures/0.2.3/src/tracing_futures/lib.rs.html#166-168'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the [current] <code>Span</code>, returning an <code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.in_current_span">Read more</a></p>
</div></div><h3id='impl-Same%3CT%3E'class='impl'><codeclass='in-band'>impl<T> Same<T> for T</code><ahref='#impl-Same%3CT%3E'class='anchor'></a></h3><divclass='impl-items'><h4id='associatedtype.Output'class="type"><code>type <ahref='#associatedtype.Output'class="type">Output</a> = T</code></h4><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></div><h3id='impl-TryFrom%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></code><ahref='#impl-TryFrom%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#607-616'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error'class="type"><code>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error'class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_from'class="method hidden"><code>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from'class='fnname'>try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#613-615'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryInto%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><ahref='#impl-TryInto%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#593-602'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error-1'class="type"><code>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error'class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="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><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_into'class="method hidden"><code>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into'class='fnname'>try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#599-601'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>