Crate mz_ore

Internal utility libraries for Materialize.

ore (n): the raw material from which more valuable materials are extracted. Modules are included in this crate when they are broadly useful but too small to warrant their own crate.

Re-exports

pub use overflowing::Overflowing;overflowing

Modules

assertassert-no-tracing

Assertion utilities.

bits

Utilities for bit and byte manipulation

bytesbytes

One bytes type to rule them all!

cast

Cast utilities.

channelasync

Channel utilities and extensions.

clicli

Command-line parsing utilities.

collections

Collection utilities.

env

Process environment utilities.

error

Error utilities.

fmt

Formatting utilities.

futureasync

Future and stream utilities.

graph

Graph utilities.

hash

Hash utilities.

hint

Extensions to std::hint.

id_gen

ID generation utilities.

iter

Iterator utilities.

lex

Lexing utilities.

lgbytesbytes and region

The bytes crate but backed by lgalloc.

metricsmetrics

Metrics for materialize systems.

netionetwork

Network I/O utilities.

now

Now utilities.

num

Number utilities

option

Option utilities.

overflowingoverflowing

Overflowing number types.

panic

Panic utilities.

path

Path utilities.

permutations

Functions for working with permutations

process

Process utilities.

region

Region-allocated data utilities.

resultprocess

Result utilities.

retryasync

Retry utilities.

serde

Serde utilities.

stackstack

Stack management utilities.

stats

Statistics utilities.

str

String utilities.

taskasync

Tokio task utilities.

testtest or test

Test utilities.

thread

Thread utilities.

time

Timing related extensions.

tracingtracing

Tracing utilities.

treat_as_equal

A newtype for values that should be ignored when comparing two values for equality.

url

URL utilities.

vec

Vector utilities.

Macros

assert_containsassert-no-tracing

Asserts that the left expression contains the right expression.

assert_errassert-no-tracing

Asserts that the provided expression, that returns a Result, is Err.

assert_noneassert-no-tracing

Asserts that the provided expression, that returns an Option, is None.

assert_okassert-no-tracing

Asserts that the provided expression, that returns a Result, is Ok.

exittracing

Prints the given message and exits the process.

halttracing

Halts the process.

metricmetrics

Define a metric for use in materialize.

soft_assert_eq_no_logassert-no-tracing

Asserts that two values are equal if soft assertions are enabled.

soft_assert_eq_or_logassert-no-tracing

Asserts that two expressions are equal to each other if soft assertions are enabled, or logs an error if soft assertions are disabled and the two expressions are not equal.

soft_assert_ne_no_logassert-no-tracing

Asserts that two values are not equal if soft assertions are enabled.

soft_assert_ne_or_logassert-no-tracing

Asserts that two expressions are not equal to each other if soft assertions are enabled, or logs an error if soft assertions are disabled and the two expressions are not equal.

soft_assert_no_logassert-no-tracing

Asserts that a condition is true if soft assertions are enabled.

soft_assert_or_logassert-no-tracing

Asserts that a condition is true if soft assertions are enabled, or logs an error if soft assertions are disabled and the condition is false.

soft_panic_no_logassert-no-tracing

Panics if soft assertions are enabled.

soft_panic_or_logassert-no-tracing

Panics if soft assertions are enabled, or logs an error if soft assertions are disabled.

Attribute Macros

instrument

Materialize wrapper around the #[tracing::insrument] macro.

static_list

A macro that collects all of the static objects of a specific type in the annotated module into a single list.

test

Materialize wrapper around the test macro.