Files
phy/rustix/time/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

5 lines
8.4 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="Time-related operations."><title>rustix::time - 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 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="../../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="#">Module time</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><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate rustix</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></span><h1>Module <span>time</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/time/mod.rs.html#1-11">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Time-related operations.</p>
</div></details><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.TimerfdFlags.html" title="struct rustix::time::TimerfdFlags">Timerfd<wbr>Flags</a></div><div class="desc docblock-short"><code>TFD_*</code> flags for use with <a href="fn.timerfd_create.html" title="fn rustix::time::timerfd_create"><code>timerfd_create</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.TimerfdTimerFlags.html" title="struct rustix::time::TimerfdTimerFlags">Timerfd<wbr>Timer<wbr>Flags</a></div><div class="desc docblock-short"><code>TFD_TIMER_*</code> flags for use with <a href="fn.timerfd_settime.html" title="fn rustix::time::timerfd_settime"><code>timerfd_settime</code></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.ClockId.html" title="enum rustix::time::ClockId">ClockId</a></div><div class="desc docblock-short"><code>clockid_t</code>
<code>CLOCK_*</code> constants for use with <a href="fn.clock_gettime.html" title="fn rustix::time::clock_gettime"><code>clock_gettime</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.DynamicClockId.html" title="enum rustix::time::DynamicClockId">Dynamic<wbr>Clock<wbr>Id</a></div><div class="desc docblock-short"><code>clockid_t</code>
<code>CLOCK_*</code> constants for use with <a href="fn.clock_gettime_dynamic.html" title="fn rustix::time::clock_gettime_dynamic"><code>clock_gettime_dynamic</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.TimerfdClockId.html" title="enum rustix::time::TimerfdClockId">Timerfd<wbr>Clock<wbr>Id</a></div><div class="desc docblock-short"><code>CLOCK_*</code> constants for use with <a href="fn.timerfd_create.html" title="fn rustix::time::timerfd_create"><code>timerfd_create</code></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.clock_getres.html" title="fn rustix::time::clock_getres">clock_<wbr>getres</a></div><div class="desc docblock-short"><code>clock_getres(id)</code>—Returns the resolution of a clock.</div></li><li><div class="item-name"><a class="fn" href="fn.clock_gettime.html" title="fn rustix::time::clock_gettime">clock_<wbr>gettime</a></div><div class="desc docblock-short"><code>clock_gettime(id)</code>—Returns the current value of a clock.</div></li><li><div class="item-name"><a class="fn" href="fn.clock_gettime_dynamic.html" title="fn rustix::time::clock_gettime_dynamic">clock_<wbr>gettime_<wbr>dynamic</a></div><div class="desc docblock-short">Like <a href="fn.clock_gettime.html" title="fn rustix::time::clock_gettime"><code>clock_gettime</code></a> but with support for dynamic clocks.</div></li><li><div class="item-name"><a class="fn" href="fn.clock_settime.html" title="fn rustix::time::clock_settime">clock_<wbr>settime</a></div><div class="desc docblock-short"><code>clock_settime(id, timespec)</code>—Sets the current value of a settable clock.</div></li><li><div class="item-name"><a class="fn" href="fn.timerfd_create.html" title="fn rustix::time::timerfd_create">timerfd_<wbr>create</a></div><div class="desc docblock-short"><code>timerfd_create(clockid, flags)</code>—Create a timer.</div></li><li><div class="item-name"><a class="fn" href="fn.timerfd_gettime.html" title="fn rustix::time::timerfd_gettime">timerfd_<wbr>gettime</a></div><div class="desc docblock-short"><code>timerfd_gettime(clockid, flags)</code>—Query a timer.</div></li><li><div class="item-name"><a class="fn" href="fn.timerfd_settime.html" title="fn rustix::time::timerfd_settime">timerfd_<wbr>settime</a></div><div class="desc docblock-short"><code>timerfd_settime(clockid, flags, new_value)</code>—Set the time on a timer.</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.Itimerspec.html" title="type rustix::time::Itimerspec">Itimerspec</a></div><div class="desc docblock-short"><code>struct itimerspec</code> for use with <a href="fn.timerfd_gettime.html" title="fn rustix::time::timerfd_gettime"><code>timerfd_gettime</code></a> and
<a href="fn.timerfd_settime.html" title="fn rustix::time::timerfd_settime"><code>timerfd_settime</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.Nsecs.html" title="type rustix::time::Nsecs">Nsecs</a></div><div class="desc docblock-short">A type for the <code>tv_sec</code> field of <a href="../fs/type.Timespec.html" title="type rustix::fs::Timespec"><code>Timespec</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.Secs.html" title="type rustix::time::Secs">Secs</a></div><div class="desc docblock-short">A type for the <code>tv_sec</code> field of <a href="../fs/type.Timespec.html" title="type rustix::fs::Timespec"><code>Timespec</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.Timespec.html" title="type rustix::time::Timespec">Timespec</a></div><div class="desc docblock-short"><code>struct timespec</code></div></li></ul></section></div></main></body></html>