30 lines
5.9 KiB
HTML
30 lines
5.9 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="Perform an `ioctl` call."><title>ioctl in rustix::ioctl - 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="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" 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="../../rustix/index.html">rustix</a><span class="version">0.38.37</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">ioctl</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li><li><a href="#references" title="References">References</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>ioctl</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">rustix</a>::<wbr><a href="index.html">ioctl</a></span><h1>Function <span class="fn">ioctl</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/rustix/ioctl/mod.rs.html#86-102">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn ioctl<F: <a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>, I: <a class="trait" href="trait.Ioctl.html" title="trait rustix::ioctl::Ioctl">Ioctl</a>>(fd: F, ioctl: I) -> <a class="type" href="../io/type.Result.html" title="type rustix::io::Result">Result</a><I::<a class="associatedtype" href="trait.Ioctl.html#associatedtype.Output" title="type rustix::ioctl::Ioctl::Output">Output</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Perform an <code>ioctl</code> call.</p>
|
|
<p><code>ioctl</code> was originally intended to act as a way of modifying the behavior
|
|
of files, but has since been adopted as a general purpose system call for
|
|
making calls into the kernel. In addition to the default calls exposed by
|
|
generic file descriptors, many drivers expose their own <code>ioctl</code> calls for
|
|
controlling their behavior, some of which are proprietary.</p>
|
|
<p>This crate exposes many other <code>ioctl</code> interfaces with safe and idiomatic
|
|
wrappers, like <a href="../io/fn.ioctl_fionbio.html" title="fn rustix::io::ioctl_fionbio"><code>ioctl_fionbio</code></a> and <a href="../io/fn.ioctl_fionread.html" title="fn rustix::io::ioctl_fionread"><code>ioctl_fionread</code></a>. It is recommended
|
|
to use those instead of this function, as they are safer and more
|
|
idiomatic. For other cases, implement the <a href="trait.Ioctl.html" title="trait rustix::ioctl::Ioctl"><code>Ioctl</code></a> API and pass it to this
|
|
function.</p>
|
|
<p>See documentation for <a href="trait.Ioctl.html" title="trait rustix::ioctl::Ioctl"><code>Ioctl</code></a> for more information.</p>
|
|
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
|
<p>While <a href="trait.Ioctl.html" title="trait rustix::ioctl::Ioctl"><code>Ioctl</code></a> takes much of the unsafety out of <code>ioctl</code> calls, it is
|
|
still unsafe to call this code with arbitrary device drivers, as it is up
|
|
to the device driver to implement the <code>ioctl</code> call correctly. It is on the
|
|
onus of the protocol between the user and the driver to ensure that the
|
|
<code>ioctl</code> call is safe to make.</p>
|
|
<h2 id="references"><a class="doc-anchor" href="#references">§</a>References</h2>
|
|
<ul>
|
|
<li><a href="https://man7.org/linux/man-pages/man2/ioctl.2.html">Linux</a></li>
|
|
<li><a href="https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-ioctlsocket">Winsock</a></li>
|
|
<li><a href="https://man.freebsd.org/cgi/man.cgi?query=ioctl&sektion=2">FreeBSD</a></li>
|
|
<li><a href="https://man.netbsd.org/ioctl.2">NetBSD</a></li>
|
|
<li><a href="https://man.openbsd.org/ioctl.2">OpenBSD</a></li>
|
|
<li><a href="https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/ioctl.2.html">Apple</a></li>
|
|
<li><a href="https://docs.oracle.com/cd/E23824_01/html/821-1463/ioctl-2.html">Solaris</a></li>
|
|
<li><a href="https://illumos.org/man/2/ioctl">illumos</a></li>
|
|
</ul>
|
|
</div></details></section></div></main></body></html> |