mirror of
https://github.com/NotAShelf/mpvrc.git
synced 2026-04-16 16:03:48 +00:00
17 lines
No EOL
6.5 KiB
HTML
17 lines
No EOL
6.5 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="An implementation of the Rust channel API over process boundaries. Under the hood, this API uses Mach ports on Mac and file descriptor passing over Unix sockets on Linux. The serde library is used to serialize values for transport over the wire."><title>ipc_channel - 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="../crates.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 crate"><!--[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"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#features" title="Features">Features</a><ul><li><a href="#force-inprocess" title="`force-inprocess`"><code>force-inprocess</code></a></li><li><a href="#memfd" title="`memfd`"><code>memfd</code></a></li><li><a href="#unstable" title="`unstable`"><code>unstable</code></a></li></ul></li></ul><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>ipc_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/lib.rs.html#10-64">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An implementation of the Rust channel API over process boundaries. Under the
|
||
hood, this API uses Mach ports on Mac and file descriptor passing over Unix
|
||
sockets on Linux. The serde library is used to serialize values for transport
|
||
over the wire.</p>
|
||
<h2 id="features"><a class="doc-anchor" href="#features">§</a>Features</h2><h3 id="force-inprocess"><a class="doc-anchor" href="#force-inprocess">§</a><code>force-inprocess</code></h3>
|
||
<p>Force the <code>inprocess</code> backend to be used instead of the OS specific backend.
|
||
The <code>inprocess</code> backend is a dummy back-end, that behaves like the real ones,
|
||
but doesn’t actually work between processes.</p>
|
||
<h3 id="memfd"><a class="doc-anchor" href="#memfd">§</a><code>memfd</code></h3>
|
||
<p>Use <a href="http://man7.org/linux/man-pages/man2/memfd_create.2.html">memfd_create</a> to back <a href="platform/struct.OsIpcSharedMemory.html">OsIpcSharedMemory</a> on Linux. <a href="http://man7.org/linux/man-pages/man2/memfd_create.2.html">memfd_create</a> was
|
||
introduced in kernel version 3.17. <strong>WARNING:</strong> Enabling this feature with kernel
|
||
version less than 3.17 will cause panics on any use of <a href="ipc/struct.IpcSharedMemory.html">IpcSharedMemory</a>.</p>
|
||
<h3 id="unstable"><a class="doc-anchor" href="#unstable">§</a><code>unstable</code></h3></div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="ipc/index.html" title="mod ipc_channel::ipc">ipc</a></div></li><li><div class="item-name"><a class="mod" href="platform/index.html" title="mod ipc_channel::platform">platform</a></div></li><li><div class="item-name"><a class="mod" href="router/index.html" title="mod ipc_channel::router">router</a></div><div class="desc docblock-short">Routers allow converting IPC channels to crossbeam channels.
|
||
The <a href="router/struct.RouterProxy.html" title="struct ipc_channel::router::RouterProxy">RouterProxy</a> provides various methods to register
|
||
<code>IpcReceiver<T></code>s. The router will then either call the appropriate callback or route the
|
||
message to a crossbeam <code>Sender<T></code> or <code>Receiver<T></code>. You should use the global <code>ROUTER</code> to
|
||
access the <code>RouterProxy</code> methods (via <code>ROUTER</code>’s <code>Deref</code> for <code>RouterProxy</code>.</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.ErrorKind.html" title="enum ipc_channel::ErrorKind">Error<wbr>Kind</a></div><div class="desc docblock-short">The kind of error that can be produced during a serialization or deserialization.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Error.html" title="type ipc_channel::Error">Error</a></div><div class="desc docblock-short">An error that can be produced during (de)serializing.</div></li></ul></section></div></main></body></html> |