<!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 `FileTypeExt` trait in crate `std`.">
<meta name="keywords" content="rust, rustlang, rust-lang, FileTypeExt">
<title>std::os::unix::fs::FileTypeExt - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../../../dark.css">
<link rel="stylesheet" type="text/css" href="../../../../main.css" id="themeStyle">
<script src="../../../../storage.js"></script>
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc trait">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
<a href='../../../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Trait FileTypeExt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.is_block_device">is_block_device</a><a href="#tymethod.is_char_device">is_char_device</a><a href="#tymethod.is_fifo">is_fifo</a><a href="#tymethod.is_socket">is_socket</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../../index.html'>std</a>::<wbr><a href='../../index.html'>os</a>::<wbr><a href='../index.html'>unix</a>::<wbr><a href='index.html'>fs</a></p><script>window.sidebarCurrent = {name: 'FileTypeExt', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Trait <a href='../../../index.html'>std</a>::<wbr><a href='../../index.html'>os</a>::<wbr><a href='../index.html'>unix</a>::<wbr><a href='index.html'>fs</a>::<wbr><a class="trait" href=''>FileTypeExt</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.5.0'>1.5.0</span><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a class='srclink' href='../../../../src/std/sys/unix/ext/fs.rs.html#560-633' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait FileTypeExt {
fn <a href='#tymethod.is_block_device' class='fnname'>is_block_device</a>(&self) -> <a class="primitive" href="../../../primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.is_char_device' class='fnname'>is_char_device</a>(&self) -> <a class="primitive" href="../../../primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.is_fifo' class='fnname'>is_fifo</a>(&self) -> <a class="primitive" href="../../../primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.is_socket' class='fnname'>is_socket</a>(&self) -> <a class="primitive" href="../../../primitive.bool.html">bool</a>;
}</pre><div class='stability'><div class='stab portability'>This is supported on <strong>Unix</strong> only.</div></div><div class='docblock'><p>Add support for special unix types (block/char device, fifo and socket).</p>
</div>
<h2 id='required-methods' class='small-section-header'>
Required Methods<a href='#required-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='tymethod.is_block_device' class='method'><span id='is_block_device.v' class='invisible'><code>fn <a href='#tymethod.is_block_device' class='fnname'>is_block_device</a>(&self) -> <a class="primitive" href="../../../primitive.bool.html">bool</a></code></span></h3><div class='stability'><div class='stab portability'>This is supported on <strong>Unix</strong> only.</div></div><div class='docblock'><p>Returns whether this file type is a block device.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">fs</span>::<span class="ident">FileTypeExt</span>;
<span class="kw">let</span> <span class="ident">meta</span> <span class="op">=</span> <span class="ident">fs</span>::<span class="ident">metadata</span>(<span class="string">"block_device_file"</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">file_type</span> <span class="op">=</span> <span class="ident">meta</span>.<span class="ident">file_type</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">file_type</span>.<span class="ident">is_block_device</span>());<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Afs%3B%0Ause%20std%3A%3Aos%3A%3Aunix%3A%3Afs%3A%3AFileTypeExt%3B%0A%0Ause%20std%3A%3Aio%3B%0Afn%20f()%20-%3E%20io%3A%3AResult%3C()%3E%20%7B%0Alet%20meta%20%3D%20fs%3A%3Ametadata(%22block_device_file%22)%3F%3B%0Alet%20file_type%20%3D%20meta.file_type()%3B%0Aassert!(file_type.is_block_device())%3B%0AOk(())%0A%7D%0A%7D">Run</a></pre>
</div><h3 id='tymethod.is_char_device' class='method'><span id='is_char_device.v' class='invisible'><code>fn <a href='#tymethod.is_char_device' class='fnname'>is_char_device</a>(&self) -> <a class="primitive" href="../../../primitive.bool.html">bool</a></code></span></h3><div class='stability'><div class='stab portability'>This is supported on <strong>Unix</strong> only.</div></div><div class='docblock'><p>Returns whether this file type is a char device.</p>
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">fs</span>::<span class="ident">FileTypeExt</span>;
<span class="kw">let</span> <span class="ident">meta</span> <span class="op">=</span> <span class="ident">fs</span>::<span class="ident">metadata</span>(<span class="string">"char_device_file"</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">file_type</span> <span class="op">=</span> <span class="ident">meta</span>.<span class="ident">file_type</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">file_type</span>.<span class="ident">is_char_device</span>());<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Afs%3B%0Ause%20std%3A%3Aos%3A%3Aunix%3A%3Afs%3A%3AFileTypeExt%3B%0A%0Ause%20std%3A%3Aio%3B%0Afn%20f()%20-%3E%20io%3A%3AResult%3C()%3E%20%7B%0Alet%20meta%20%3D%20fs%3A%3Ametadata(%22char_device_file%22)%3F%3B%0Alet%20file_type%20%3D%20meta.file_type()%3B%0Aassert!(file_type.is_char_device())%3B%0AOk(())%0A%7D%0A%7D">Run</a></pre>
</div><h3 id='tymethod.is_fifo' class='method'><span id='is_fifo.v' class='invisible'><code>fn <a href='#tymethod.is_fifo' class='fnname'>is_fifo</a>(&self) -> <a class="primitive" href="../../../primitive.bool.html">bool</a></code></span></h3><div class='stability'><div class='stab portability'>This is supported on <strong>Unix</strong> only.</div></div><div class='docblock'><p>Returns whether this file type is a fifo.</p>
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">fs</span>::<span class="ident">FileTypeExt</span>;
<span class="kw">let</span> <span class="ident">meta</span> <span class="op">=</span> <span class="ident">fs</span>::<span class="ident">metadata</span>(<span class="string">"fifo_file"</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">file_type</span> <span class="op">=</span> <span class="ident">meta</span>.<span class="ident">file_type</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">file_type</span>.<span class="ident">is_fifo</span>());<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Afs%3B%0Ause%20std%3A%3Aos%3A%3Aunix%3A%3Afs%3A%3AFileTypeExt%3B%0A%0Ause%20std%3A%3Aio%3B%0Afn%20f()%20-%3E%20io%3A%3AResult%3C()%3E%20%7B%0Alet%20meta%20%3D%20fs%3A%3Ametadata(%22fifo_file%22)%3F%3B%0Alet%20file_type%20%3D%20meta.file_type()%3B%0Aassert!(file_type.is_fifo())%3B%0AOk(())%0A%7D%0A%7D">Run</a></pre>
</div><h3 id='tymethod.is_socket' class='method'><span id='is_socket.v' class='invisible'><code>fn <a href='#tymethod.is_socket' class='fnname'>is_socket</a>(&self) -> <a class="primitive" href="../../../primitive.bool.html">bool</a></code></span></h3><div class='stability'><div class='stab portability'>This is supported on <strong>Unix</strong> only.</div></div><div class='docblock'><p>Returns whether this file type is a socket.</p>
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">fs</span>::<span class="ident">FileTypeExt</span>;
<span class="kw">let</span> <span class="ident">meta</span> <span class="op">=</span> <span class="ident">fs</span>::<span class="ident">metadata</span>(<span class="string">"unix.socket"</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">file_type</span> <span class="op">=</span> <span class="ident">meta</span>.<span class="ident">file_type</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">file_type</span>.<span class="ident">is_socket</span>());<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Afs%3B%0Ause%20std%3A%3Aos%3A%3Aunix%3A%3Afs%3A%3AFileTypeExt%3B%0A%0Ause%20std%3A%3Aio%3B%0Afn%20f()%20-%3E%20io%3A%3AResult%3C()%3E%20%7B%0Alet%20meta%20%3D%20fs%3A%3Ametadata(%22unix.socket%22)%3F%3B%0Alet%20file_type%20%3D%20meta.file_type()%3B%0Aassert!(file_type.is_socket())%3B%0AOk(())%0A%7D%0A%7D">Run</a></pre>
</div></div>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><div class='out-of-band'><a class='srclink' href='../../../../src/std/sys/unix/ext/fs.rs.html#636-641' title='goto source code'>[src]</a></div><code>impl FileTypeExt for <a class="struct" href="../../../../std/fs/struct.FileType.html" title="struct std::fs::FileType">FileType</a></code></li>
</ul><script type="text/javascript" async
src="../../../../implementors/std/os/unix/fs/trait.FileTypeExt.js">
</script></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../../";
window.currentCrate = "std";
</script>
<script src="../../../../main.js"></script>
<script defer src="../../../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
fdedb3cf2140df9b6d419a2338ab1caa
>
files
>
5251
