NotAShelf/mpvrc
1
0
Fork 0
mirror of https://github.com/NotAShelf/mpvrc.git synced 2026-04-26 19:37:41 +00:00
Code Issues Projects Releases Packages Wiki Activity

deploy: de38ae62916547ad097c066f94a32e9ba7790eeb

Browse source
This commit is contained in:
NotAShelf 2025-02-05 00:10:33 +00:00
commit 9a86359447
28502 changed files with 1261284 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
ipc_channel/ipc/enum.IpcError.html Normal file
View file

File diff suppressed because one or more lines are too long

23
ipc_channel/ipc/enum.IpcSelectionResult.html Normal file
View file

@ -0,0 +1,23 @@
<!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="Result for readable events returned from IpcReceiverSet::select."><title>IpcSelectionResult in ipc_channel::ipc - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ipc_channel" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc enum"><!--[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="../../ipc_channel/index.html">ipc_<wbr>channel</a><span class="version">0.19.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">IpcSelection<wbr>Result</a></h2><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.ChannelClosed" title="ChannelClosed">ChannelClosed</a></li><li><a href="#variant.MessageReceived" title="MessageReceived">MessageReceived</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.unwrap" title="unwrap">unwrap</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-IpcSelectionResult" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-IpcSelectionResult" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-IpcSelectionResult" title="Send">Send</a></li><li><a href="#impl-Sync-for-IpcSelectionResult" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-IpcSelectionResult" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-IpcSelectionResult" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In ipc_<wbr>channel::<wbr>ipc</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">ipc_channel</a>::<wbr><a href="index.html">ipc</a></span><h1>Enum <span class="enum">IpcSelectionResult</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/ipc_channel/ipc.rs.html#631-638">Source</a> </span></div><pre class="rust item-decl"><code>pub enum IpcSelectionResult {
MessageReceived(<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>, <a class="struct" href="struct.IpcMessage.html" title="struct ipc_channel::ipc::IpcMessage">IpcMessage</a>),
ChannelClosed(<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>),
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Result for readable events returned from <a href="struct.IpcReceiverSet.html#method.select">IpcReceiverSet::select</a>.</p>
</div></details><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.MessageReceived" class="variant"><a href="#variant.MessageReceived" class="anchor">§</a><h3 class="code-header">MessageReceived(<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>, <a class="struct" href="struct.IpcMessage.html" title="struct ipc_channel::ipc::IpcMessage">IpcMessage</a>)</h3></section><div class="docblock"><p>A message received from the <a href="struct.IpcReceiver.html" title="struct ipc_channel::ipc::IpcReceiver"><code>IpcReceiver</code></a> in the <a href="struct.IpcMessage.html" title="struct ipc_channel::ipc::IpcMessage"><code>IpcMessage</code></a> form,
identified by the <code>u64</code> value.</p>
</div><section id="variant.ChannelClosed" class="variant"><a href="#variant.ChannelClosed" class="anchor">§</a><h3 class="code-header">ChannelClosed(<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>)</h3></section><div class="docblock"><p>The channel has been closed for the <a href="struct.IpcReceiver.html" title="struct ipc_channel::ipc::IpcReceiver">IpcReceiver</a> identified by the <code>u64</code> value.
<a href="struct.IpcReceiver.html" title="struct ipc_channel::ipc::IpcReceiver">IpcReceiver</a>: struct.IpcReceiver.html</p>
</div></div><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-IpcSelectionResult" class="impl"><a class="src rightside" href="../../src/ipc_channel/ipc.rs.html#640-659">Source</a><a href="#impl-IpcSelectionResult" class="anchor">§</a><h3 class="code-header">impl <a class="enum" href="enum.IpcSelectionResult.html" title="enum ipc_channel::ipc::IpcSelectionResult">IpcSelectionResult</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.unwrap" class="method"><a class="src rightside" href="../../src/ipc_channel/ipc.rs.html#651-658">Source</a><h4 class="code-header">pub fn <a href="#method.unwrap" class="fn">unwrap</a>(self) -&gt; (<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>, <a class="struct" href="struct.IpcMessage.html" title="struct ipc_channel::ipc::IpcMessage">IpcMessage</a>)</h4></section></summary><div class="docblock"><p>Helper method to move the value out of the <a href="enum.IpcSelectionResult.html">IpcSelectionResult</a> if it
is <a href="enum.IpcSelectionResult.html#variant.MessageReceived">MessageReceived</a>.</p>
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
<p>If the result is <a href="enum.IpcSelectionResult.html#variant.ChannelClosed">ChannelClosed</a> this call will panic.</p>
</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-IpcSelectionResult" class="impl"><a href="#impl-Freeze-for-IpcSelectionResult" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="enum" href="enum.IpcSelectionResult.html" title="enum ipc_channel::ipc::IpcSelectionResult">IpcSelectionResult</a></h3></section><section id="impl-RefUnwindSafe-for-IpcSelectionResult" class="impl"><a href="#impl-RefUnwindSafe-for-IpcSelectionResult" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="enum.IpcSelectionResult.html" title="enum ipc_channel::ipc::IpcSelectionResult">IpcSelectionResult</a></h3></section><section id="impl-Send-for-IpcSelectionResult" class="impl"><a href="#impl-Send-for-IpcSelectionResult" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="enum.IpcSelectionResult.html" title="enum ipc_channel::ipc::IpcSelectionResult">IpcSelectionResult</a></h3></section><section id="impl-Sync-for-IpcSelectionResult" class="impl"><a href="#impl-Sync-for-IpcSelectionResult" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="enum.IpcSelectionResult.html" title="enum ipc_channel::ipc::IpcSelectionResult">IpcSelectionResult</a></h3></section><section id="impl-Unpin-for-IpcSelectionResult" class="impl"><a href="#impl-Unpin-for-IpcSelectionResult" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="enum.IpcSelectionResult.html" title="enum ipc_channel::ipc::IpcSelectionResult">IpcSelectionResult</a></h3></section><section id="impl-UnwindSafe-for-IpcSelectionResult" class="impl"><a href="#impl-UnwindSafe-for-IpcSelectionResult" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="enum.IpcSelectionResult.html" title="enum ipc_channel::ipc::IpcSelectionResult">IpcSelectionResult</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>

15
ipc_channel/ipc/enum.TryRecvError.html Normal file
View file

File diff suppressed because one or more lines are too long

20
ipc_channel/ipc/fn.bytes_channel.html Normal file
View file

@ -0,0 +1,20 @@
<!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="Create a connected IpcBytesSender and IpcBytesReceiver."><title>bytes_channel in ipc_channel::ipc - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ipc_channel" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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="../../ipc_channel/index.html">ipc_<wbr>channel</a><span class="version">0.19.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">bytes_<wbr>channel</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In ipc_<wbr>channel::<wbr>ipc</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">ipc_channel</a>::<wbr><a href="index.html">ipc</a></span><h1>Function <span class="fn">bytes_channel</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/ipc_channel/ipc.rs.html#168-173">Source</a> </span></div><pre class="rust item-decl"><code>pub fn bytes_channel() -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(<a class="struct" href="struct.IpcBytesSender.html" title="struct ipc_channel::ipc::IpcBytesSender">IpcBytesSender</a>, <a class="struct" href="struct.IpcBytesReceiver.html" title="struct ipc_channel::ipc::IpcBytesReceiver">IpcBytesReceiver</a>), <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create a connected <a href="struct.IpcBytesSender.html">IpcBytesSender</a> and <a href="struct.IpcBytesReceiver.html">IpcBytesReceiver</a>.</p>
<p>Note: The <a href="struct.IpcBytesSender.html">IpcBytesSender</a> transfers messages of the type <code>[u8]</code>
and the <a href="struct.IpcBytesReceiver.html">IpcBytesReceiver</a> receives a <code>Vec&lt;u8&gt;</code>. This sender/receiver
type does not serialize/deserialize messages through <code>serde</code>, making
it more efficient where applicable.</p>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span>payload = <span class="string">b"'Tis but a scratch!!"</span>;
<span class="comment">// Create a channel
</span><span class="kw">let </span>(tx, rx) = ipc::bytes_channel().unwrap();
<span class="comment">// Send data
</span>tx.send(payload).unwrap();
<span class="comment">// Receive the data
</span><span class="kw">let </span>response = rx.recv().unwrap();
<span class="macro">assert_eq!</span>(response, payload);</code></pre></div>
</div></details></section></div></main></body></html>

23
ipc_channel/ipc/fn.channel.html Normal file
View file

@ -0,0 +1,23 @@
<!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="Create a connected IpcSender and IpcReceiver that transfer messages of a given type provided by type `T` or inferred by the types of messages sent by the sender."><title>channel in ipc_channel::ipc - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ipc_channel" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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="../../ipc_channel/index.html">ipc_<wbr>channel</a><span class="version">0.19.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">channel</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In ipc_<wbr>channel::<wbr>ipc</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">ipc_channel</a>::<wbr><a href="index.html">ipc</a></span><h1>Function <span class="fn">channel</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/ipc_channel/ipc.rs.html#124-138">Source</a> </span></div><pre class="rust item-decl"><code>pub fn channel&lt;T&gt;() -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(<a class="struct" href="struct.IpcSender.html" title="struct ipc_channel::ipc::IpcSender">IpcSender</a>&lt;T&gt;, <a class="struct" href="struct.IpcReceiver.html" title="struct ipc_channel::ipc::IpcReceiver">IpcReceiver</a>&lt;T&gt;), <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;<div class="where">where
T: for&lt;'de&gt; <a class="trait" href="../../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a>&lt;'de&gt; + <a class="trait" href="../../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create a connected <a href="struct.IpcSender.html">IpcSender</a> and <a href="struct.IpcReceiver.html">IpcReceiver</a> that
transfer messages of a given type provided by type <code>T</code>
or inferred by the types of messages sent by the sender.</p>
<p>Messages sent by the sender will be available to the
receiver even if the sender or receiver has been moved
to a different process. In addition, receivers and senders
may be sent over an existing channel.</p>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">let </span>payload = <span class="string">"Hello, World!"</span>.to_owned();
<span class="comment">// Create a channel
</span><span class="kw">let </span>(tx, rx) = ipc::channel().unwrap();
<span class="comment">// Send data
</span>tx.send(payload).unwrap();
<span class="comment">// Receive the data
</span><span class="kw">let </span>response = rx.recv().unwrap();
<span class="macro">assert_eq!</span>(response, <span class="string">"Hello, World!"</span>.to_owned());</code></pre></div>
</div></details></section></div></main></body></html>

6
ipc_channel/ipc/index.html Normal file
View file

@ -0,0 +1,6 @@
<!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 `ipc` mod in crate `ipc_channel`."><title>ipc_channel::ipc - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ipc_channel" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[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="../../ipc_channel/index.html">ipc_<wbr>channel</a><span class="version">0.19.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module ipc</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate ipc_<wbr>channel</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">ipc_channel</a></span><h1>Module <span>ipc</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/ipc_channel/ipc.rs.html#10-1017">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.IpcBytesReceiver.html" title="struct ipc_channel::ipc::IpcBytesReceiver">IpcBytes<wbr>Receiver</a></div><div class="desc docblock-short">Receiving end of a channel that does not used serialized messages.</div></li><li><div class="item-name"><a class="struct" href="struct.IpcBytesSender.html" title="struct ipc_channel::ipc::IpcBytesSender">IpcBytes<wbr>Sender</a></div><div class="desc docblock-short">Sending end of a channel that does not used serialized messages.</div></li><li><div class="item-name"><a class="struct" href="struct.IpcMessage.html" title="struct ipc_channel::ipc::IpcMessage">IpcMessage</a></div><div class="desc docblock-short">Structure used to represent a raw message from an <a href="struct.IpcSender.html" title="struct ipc_channel::ipc::IpcSender"><code>IpcSender</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.IpcOneShotServer.html" title="struct ipc_channel::ipc::IpcOneShotServer">IpcOne<wbr>Shot<wbr>Server</a></div><div class="desc docblock-short">A server associated with a given name.</div></li><li><div class="item-name"><a class="struct" href="struct.IpcReceiver.html" title="struct ipc_channel::ipc::IpcReceiver">IpcReceiver</a></div><div class="desc docblock-short">Receiving end of a channel using serialized messages.</div></li><li><div class="item-name"><a class="struct" href="struct.IpcReceiverSet.html" title="struct ipc_channel::ipc::IpcReceiverSet">IpcReceiver<wbr>Set</a></div><div class="desc docblock-short">Collection of <a href="struct.IpcReceiver.html">IpcReceiver</a>s moved into the set; thus creating a common
(and exclusive) endpoint for receiving messages on any of the added
channels.</div></li><li><div class="item-name"><a class="struct" href="struct.IpcSender.html" title="struct ipc_channel::ipc::IpcSender">IpcSender</a></div><div class="desc docblock-short">Sending end of a channel using serialized messages.</div></li><li><div class="item-name"><a class="struct" href="struct.IpcSharedMemory.html" title="struct ipc_channel::ipc::IpcSharedMemory">IpcShared<wbr>Memory</a></div><div class="desc docblock-short">Shared memory descriptor that will be made accessible to the receiver
of an IPC message that contains the discriptor.</div></li><li><div class="item-name"><a class="struct" href="struct.OpaqueIpcReceiver.html" title="struct ipc_channel::ipc::OpaqueIpcReceiver">Opaque<wbr>IpcReceiver</a></div></li><li><div class="item-name"><a class="struct" href="struct.OpaqueIpcSender.html" title="struct ipc_channel::ipc::OpaqueIpcSender">Opaque<wbr>IpcSender</a></div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.IpcError.html" title="enum ipc_channel::ipc::IpcError">IpcError</a></div></li><li><div class="item-name"><a class="enum" href="enum.IpcSelectionResult.html" title="enum ipc_channel::ipc::IpcSelectionResult">IpcSelection<wbr>Result</a></div><div class="desc docblock-short">Result for readable events returned from <a href="struct.IpcReceiverSet.html#method.select">IpcReceiverSet::select</a>.</div></li><li><div class="item-name"><a class="enum" href="enum.TryRecvError.html" title="enum ipc_channel::ipc::TryRecvError">TryRecv<wbr>Error</a></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.bytes_channel.html" title="fn ipc_channel::ipc::bytes_channel">bytes_<wbr>channel</a></div><div class="desc docblock-short">Create a connected <a href="struct.IpcBytesSender.html">IpcBytesSender</a> and <a href="struct.IpcBytesReceiver.html">IpcBytesReceiver</a>.</div></li><li><div class="item-name"><a class="fn" href="fn.channel.html" title="fn ipc_channel::ipc::channel">channel</a></div><div class="desc docblock-short">Create a connected <a href="struct.IpcSender.html">IpcSender</a> and <a href="struct.IpcReceiver.html">IpcReceiver</a> that
transfer messages of a given type provided by type <code>T</code>
or inferred by the types of messages sent by the sender.</div></li></ul></section></div></main></body></html>

1
ipc_channel/ipc/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["IpcError","IpcSelectionResult","TryRecvError"],"fn":["bytes_channel","channel"],"struct":["IpcBytesReceiver","IpcBytesSender","IpcMessage","IpcOneShotServer","IpcReceiver","IpcReceiverSet","IpcSender","IpcSharedMemory","OpaqueIpcReceiver","OpaqueIpcSender"]};

17
ipc_channel/ipc/struct.IpcBytesReceiver.html Normal file
View file

File diff suppressed because one or more lines are too long

17
ipc_channel/ipc/struct.IpcBytesSender.html Normal file
View file

File diff suppressed because one or more lines are too long

18
ipc_channel/ipc/struct.IpcMessage.html Normal file
View file

File diff suppressed because one or more lines are too long

40
ipc_channel/ipc/struct.IpcOneShotServer.html Normal file
View file

File diff suppressed because one or more lines are too long

56
ipc_channel/ipc/struct.IpcReceiver.html Normal file
View file

File diff suppressed because one or more lines are too long

50
ipc_channel/ipc/struct.IpcReceiverSet.html Normal file
View file

File diff suppressed because one or more lines are too long

31
ipc_channel/ipc/struct.IpcSender.html Normal file
View file

File diff suppressed because one or more lines are too long

1166
ipc_channel/ipc/struct.IpcSharedMemory.html Normal file
View file

File diff suppressed because one or more lines are too long

15
ipc_channel/ipc/struct.OpaqueIpcReceiver.html Normal file
View file

File diff suppressed because one or more lines are too long

17
ipc_channel/ipc/struct.OpaqueIpcSender.html Normal file
View file

File diff suppressed because one or more lines are too long