mirror of
https://github.com/NotAShelf/mpvrc.git
synced 2026-04-17 00:13:48 +00:00
20 lines
No EOL
4.8 KiB
HTML
20 lines
No EOL
4.8 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="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() -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(<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>></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<u8></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> |