mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 23:14:34 +01:00
13 lines
11 KiB
HTML
13 lines
11 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="Write half of a serial interface"><title>Write in embedded_hal::serial - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="embedded_hal" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../embedded_hal/index.html">embedded_<wbr>hal</a><span class="version">0.2.7</span></h2></div><h2 class="location"><a href="#">Write</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error">Error</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.flush">flush</a></li><li><a href="#tymethod.write">write</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Write-for-dyn+Write%3CWord,+Error+=+Error%3E">Write</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In embedded_<wbr>hal::<wbr>serial</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">embedded_hal</a>::<wbr><a href="index.html">serial</a>::<wbr><a class="trait" href="#">Write</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/embedded_hal/serial.rs.html#18-27">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Write<Word> {
|
||
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>;
|
||
|
|
|
||
|
|
// Required methods
|
||
|
|
fn <a href="#tymethod.write" class="fn">write</a>(&mut self, word: Word) -> Result<<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Write.html#associatedtype.Error" title="type embedded_hal::serial::Write::Error">Error</a>>;
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.flush" class="fn">flush</a>(&mut self) -> Result<<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Write.html#associatedtype.Error" title="type embedded_hal::serial::Write::Error">Error</a>>;
|
||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Write half of a serial interface</p>
|
||
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Error" class="method"><a class="src rightside" href="../../src/embedded_hal/serial.rs.html#20">source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a></h4></section></summary><div class="docblock"><p>Write error</p>
|
||
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.write" class="method"><a class="src rightside" href="../../src/embedded_hal/serial.rs.html#23">source</a><h4 class="code-header">fn <a href="#tymethod.write" class="fn">write</a>(&mut self, word: Word) -> Result<<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Write.html#associatedtype.Error" title="type embedded_hal::serial::Write::Error">Error</a>></h4></section></summary><div class="docblock"><p>Writes a single word to the serial interface</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.flush" class="method"><a class="src rightside" href="../../src/embedded_hal/serial.rs.html#26">source</a><h4 class="code-header">fn <a href="#tymethod.flush" class="fn">flush</a>(&mut self) -> Result<<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Write.html#associatedtype.Error" title="type embedded_hal::serial::Write::Error">Error</a>></h4></section></summary><div class="docblock"><p>Ensures that none of the previously written words are still buffered</p>
|
||
|
|
</div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Write-for-dyn+Write%3CWord,+Error+=+Error%3E" class="impl"><a class="src rightside" href="../../src/embedded_hal/fmt.rs.html#6-18">source</a><a href="#impl-Write-for-dyn+Write%3CWord,+Error+=+Error%3E" class="anchor">§</a><h3 class="code-header">impl<Word, Error> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Write.html" title="trait core::fmt::Write">Write</a> for dyn <a class="trait" href="trait.Write.html" title="trait embedded_hal::serial::Write">Write</a><Word, Error = Error><div class="where">where
|
||
|
|
Word: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.write_str" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal/fmt.rs.html#10-17">source</a><a href="#method.write_str" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Write.html#tymethod.write_str" class="fn">write_str</a>(&mut self, s: &<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.str.html">str</a>) -> <a class="type" href="https://doc.rust-lang.org/1.82.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Writes a string slice into this writer, returning whether the write
|
||
|
|
succeeded. <a href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Write.html#tymethod.write_str">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_char" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.1.0">1.1.0</span> · <a class="src" href="https://doc.rust-lang.org/1.82.0/src/core/fmt/mod.rs.html#174">source</a></span><a href="#method.write_char" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Write.html#method.write_char" class="fn">write_char</a>(&mut self, c: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.char.html">char</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.82.0/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></h4></section></summary><div class='docblock'>Writes a <a href="https://doc.rust-lang.org/1.82.0/core/primitive.char.html" title="primitive char"><code>char</code></a> into this writer, returning whether the write succeeded. <a href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Write.html#method.write_char">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_fmt" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.82.0/src/core/fmt/mod.rs.html#202">source</a></span><a href="#method.write_fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Write.html#method.write_fmt" class="fn">write_fmt</a>(&mut self, args: <a class="struct" href="https://doc.rust-lang.org/1.82.0/core/fmt/struct.Arguments.html" title="struct core::fmt::Arguments">Arguments</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.82.0/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></h4></section></summary><div class='docblock'>Glue for usage of the <a href="https://doc.rust-lang.org/1.82.0/core/macro.write.html" title="macro core::write"><code>write!</code></a> macro with implementors of this trait. <a href="https://doc.rust-lang.org/1.82.0/core/fmt/trait.Write.html#method.write_fmt">Read more</a></div></details></div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/embedded_hal/serial/trait.Write.js" async></script></section></div></main></body></html>
|