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
gh-pages
uutils.github.io/coreutils/dev/uu_tail/chunks/index.html
T
tertsdiepraam 878d4de11f deploy: 64ff55be0e
2023-08-21 09:25:37 +00:00

13 lines
8.7 KiB
HTML
Raw Permalink 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`."><title>uu_tail::chunks - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.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-a2c9cd1067f8b328.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-f3501f0f5ae15dfb.css" id="mainThemeStyle"><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.71.1 (eb26296b5 2023-08-03)" data-search-js="search-4926e5fc22a5646a.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ></div><script src="../../static.files/storage-62ce34ea385b278a.js"></script><script defer src="../../static.files/main-f0540c1d82cde29b.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-1097f8e92a01e3cf.css"><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-7b819b6101059cd0.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" 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="struct uu_tail::chunks::ReverseChunks"><code>ReverseChunks</code></a>
or at the end of piped stdin with <a href="struct.LinesChunk.html" title="struct uu_tail::chunks::LinesChunk"><code>LinesChunk</code></a> or <a href="struct.BytesChunk.html" title="struct uu_tail::chunks::BytesChunk"><code>BytesChunk</code></a>.</p>
<p>Use <a href="struct.ReverseChunks.html#method.new" title="associated function uu_tail::chunks::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><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.BytesChunk.html" title="struct uu_tail::chunks::BytesChunk">BytesChunk</a></div><div class="desc docblock-short">A <a href="struct.BytesChunk.html" title="struct uu_tail::chunks::BytesChunk"><code>BytesChunk</code></a> storing a fixed size number of bytes in a buffer.</div></li><li><div class="item-name"><a class="struct" href="struct.BytesChunkBuffer.html" title="struct uu_tail::chunks::BytesChunkBuffer">BytesChunkBuffer</a></div><div class="desc docblock-short">An abstraction layer on top of <a href="struct.BytesChunk.html" title="struct uu_tail::chunks::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="method uu_tail::chunks::BytesChunkBuffer::fill"><code>Self::fill</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.LinesChunk.html" title="struct uu_tail::chunks::LinesChunk">LinesChunk</a></div><div class="desc docblock-short">Works similar to a <a href="struct.BytesChunk.html" title="struct uu_tail::chunks::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></li><li><div class="item-name"><a class="struct" href="struct.LinesChunkBuffer.html" title="struct uu_tail::chunks::LinesChunkBuffer">LinesChunkBuffer</a></div><div class="desc docblock-short">An abstraction layer on top of <a href="struct.LinesChunk.html" title="struct uu_tail::chunks::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="method uu_tail::chunks::LinesChunkBuffer::fill"><code>Self::fill</code></a>. Works similar like <a href="struct.BytesChunkBuffer.html" title="struct uu_tail::chunks::BytesChunkBuffer"><code>BytesChunkBuffer</code></a>, but works on top
of lines delimited by <code>self.delimiter</code> instead of bytes.</div></li><li><div class="item-name"><a class="struct" href="struct.ReverseChunks.html" title="struct uu_tail::chunks::ReverseChunks">ReverseChunks</a></div><div class="desc docblock-short">An iterator over a file in non-overlapping chunks from the end of the file.</div></li></ul><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.BLOCK_SIZE.html" title="constant uu_tail::chunks::BLOCK_SIZE">BLOCK_SIZE</a></div><div class="desc docblock-short">When reading files in reverse in <code>bounded_tail</code>, this is the size of each
block read at a time.</div></li><li><div class="item-name"><a class="constant" href="constant.BUFFER_SIZE.html" title="constant uu_tail::chunks::BUFFER_SIZE">BUFFER_SIZE</a></div><div class="desc 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></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink