Files
greptimedb/flow/utils/index.html
2026-01-08 13:00:41 +00:00

3 lines
5.6 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="utilities for managing state of dataflow execution"><title>flow::utils - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="flow" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.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]--><rustdoc-topbar><h2><a href="#">Module utils</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../flow/index.html">flow</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module utils</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="#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 flow</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">flow</a></div><h1>Module <span>utils</span>&nbsp;<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/flow/utils.rs.html#15-1041">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>utilities for managing state of dataflow execution</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.ArrangeHandler.html" title="struct flow::utils::ArrangeHandler">Arrange<wbr>Handler</a></dt><dd>A handler to the inner Arrangement, can be cloned and shared, useful for query its inner state</dd><dt><a class="struct" href="struct.Arrangement.html" title="struct flow::utils::Arrangement">Arrangement</a></dt><dd>A shared state of key-value pair for various state in dataflow execution.</dd><dt><a class="struct" href="struct.KeyExpiryManager.html" title="struct flow::utils::KeyExpiryManager">KeyExpiry<wbr>Manager</a></dt><dd>Determine when should a key expire according to its event timestamp in key.</dd><dt><a class="struct" href="struct.SizeReportSender.html" title="struct flow::utils::SizeReportSender">Size<wbr>Report<wbr>Sender</a></dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.compact_diff_row.html" title="fn flow::utils::compact_diff_row">compact_<wbr>diff_<wbr>row</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.get_value_heap_size.html" title="fn flow::utils::get_value_heap_size">get_<wbr>value_<wbr>heap_<wbr>size</a></dt><dd>Get a estimate of heap size of a value</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.ArrangeReader.html" title="type flow::utils::ArrangeReader">Arrange<wbr>Reader</a></dt><dd>Simply a type alias for ReadGuard of Arrangement</dd><dt><a class="type" href="type.ArrangeWriter.html" title="type flow::utils::ArrangeWriter">Arrange<wbr>Writer</a></dt><dd>Simply a type alias for WriteGuard of Arrangement</dd><dt><a class="type" href="type.Batch.html" title="type flow::utils::Batch">Batch</a></dt><dd>A batch of updates, arranged by key</dd><dt><a class="type" href="type.Spine.html" title="type flow::utils::Spine">Spine</a></dt><dd>A spine of batches, arranged by timestamp
TODO(discord9): consider internally index by key, value, and timestamp for faster lookup</dd><dt><a class="type" href="type.StateReportHandler.html" title="type flow::utils::StateReportHandler">State<wbr>Report<wbr>Handler</a></dt><dd>Handle the size report request, and send the report back</dd></dl></section></div></main></body></html>