uutils/uutils.github.io
0
0
Fork 0
mirror of https://github.com/uutils/uutils.github.io.git synced 2026-06-10 16:12:28 -07:00
Code Issues Packages Projects Releases Wiki Activity
Files
e5b97aefc60f59cd09480aa869bb078633e2249d
uutils.github.io/dev/uu_tail/chunks/index.html
T
sylvestre 41434b5339 deploy: f0e8d44e6e
2023-03-29 02:48:37 +00:00

13 lines
8.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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="Iterating over a file by chunks, either starting at the end of the file with [`ReverseChunks`] or at the end of piped stdin with [`LinesChunk`] or [`BytesChunk`]."><meta name="keywords" content="rust, rustlang, rust-lang, chunks"><title>uu_tail::chunks - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-93196c7a1c3542a8.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-4743e13df3dfe8c4.css"><link rel="stylesheet" disabled href="../../static.files/dark-0e1b889528bd466b.css"><link rel="stylesheet" disabled href="../../static.files/ayu-65289d5d067c7c66.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../../static.files/main-3367e395607fafc1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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">&#9776;</button><a class="logo-container" href="../../uu_tail/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../uu_tail/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Module chunks</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">uu_tail</a>::<wbr><a class="mod" href="#">chunks</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/uu_tail/chunks.rs.html#6-704">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Iterating over a file by chunks, either starting at the end of the file with <a href="struct.ReverseChunks.html" title="ReverseChunks"><code>ReverseChunks</code></a>
or at the end of piped stdin with <a href="struct.LinesChunk.html" title="LinesChunk"><code>LinesChunk</code></a> or <a href="struct.BytesChunk.html" title="BytesChunk"><code>BytesChunk</code></a>.</p>
<p>Use <a href="struct.ReverseChunks.html#method.new" title="ReverseChunks::new"><code>ReverseChunks::new</code></a> to create a new iterator over chunks of bytes from the file.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BytesChunk.html" title="uu_tail::chunks::BytesChunk struct">BytesChunk</a></div><div class="item-right docblock-short">A <a href="struct.BytesChunk.html" title="BytesChunk"><code>BytesChunk</code></a> storing a fixed size number of bytes in a buffer.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BytesChunkBuffer.html" title="uu_tail::chunks::BytesChunkBuffer struct">BytesChunkBuffer</a></div><div class="item-right docblock-short">An abstraction layer on top of <a href="struct.BytesChunk.html" title="BytesChunk"><code>BytesChunk</code></a> mainly to simplify filling only the needed amount
of chunks. See also <a href="struct.BytesChunkBuffer.html#method.fill" title="Self::fill"><code>Self::fill</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LinesChunk.html" title="uu_tail::chunks::LinesChunk struct">LinesChunk</a></div><div class="item-right docblock-short">Works similar to a <a href="struct.BytesChunk.html" title="BytesChunk"><code>BytesChunk</code></a> but also stores the number of lines encountered in the current
buffer. The size of the buffer is limited to a fixed size number of bytes.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LinesChunkBuffer.html" title="uu_tail::chunks::LinesChunkBuffer struct">LinesChunkBuffer</a></div><div class="item-right docblock-short">An abstraction layer on top of <a href="struct.LinesChunk.html" title="LinesChunk"><code>LinesChunk</code></a> mainly to simplify filling only the needed amount
of chunks. See also <a href="struct.LinesChunkBuffer.html#method.fill" title="Self::fill"><code>Self::fill</code></a>. Works similar like <a href="struct.BytesChunkBuffer.html" title="BytesChunkBuffer"><code>BytesChunkBuffer</code></a>, but works on top
of lines delimited by <code>self.delimiter</code> instead of bytes.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ReverseChunks.html" title="uu_tail::chunks::ReverseChunks struct">ReverseChunks</a></div><div class="item-right docblock-short">An iterator over a file in non-overlapping chunks from the end of the file.</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.BLOCK_SIZE.html" title="uu_tail::chunks::BLOCK_SIZE constant">BLOCK_SIZE</a></div><div class="item-right docblock-short">When reading files in reverse in <code>bounded_tail</code>, this is the size of each
block read at a time.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.BUFFER_SIZE.html" title="uu_tail::chunks::BUFFER_SIZE constant">BUFFER_SIZE</a></div><div class="item-right docblock-short">The size of the backing buffer of a LinesChunk or BytesChunk in bytes. The value of BUFFER_SIZE
originates from the BUFSIZ constant in stdio.h and the libc crate to make stream IO efficient.
In the latter the value is constantly set to 8192 on all platforms, where the value in stdio.h
is determined on each platform differently. Since libc chose 8192 as a reasonable default the
value here is set to this value, too.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="uu_tail" data-themes="" data-resource-suffix="" data-rustdoc-version="1.68.2 (9eb3afe9e 2023-03-27)" data-search-js="search-98d53477a794af0b.js" data-settings-js="settings-c3c521c753752a1a.js" data-settings-css="settings-08ddfdda51b8ee2e.css" ></div></body></html>
Reference in New Issue View Git Blame Copy Permalink