Skip to main content

Crate hyphae_query

Crate hyphae_query 

Source
Expand description

Deterministic typed query model and executable reference semantics.

Structs§

AggregationPlan
Optional global or grouped aggregation plan.
AggregationResult
Aggregation output. An ungrouped plan has one empty-key group.
Cursor
Logical continuation position after one emitted record.
ExecutionLimits
Runtime and shape budgets for one complete global execution.
FieldPath
Exact object-field path. An empty path selects the root value.
GroupResult
One deterministic aggregation group.
NamedMetric
Named aggregate calculation.
NamedMetricValue
Named aggregate output.
Query
Complete deterministic query request.
QueryResult
Complete successful query response.
Record
One logical record supplied to the reference query executor.
SortField
One requested sort component.
SystemClock
Production monotonic clock backed by Instant.

Enums§

BoundedQueryError
Failure from the additive query entry points that enforce an aggregate key/canonical-document byte budget.
CompareOperator
Ordered comparison operator for one resolved field.
DocumentError
Failure while encoding or verifying one canonical structured document.
Filter
Deterministic filter expression.
Metric
One aggregate calculation.
MetricValue
Value emitted by one aggregate metric.
NullPlacement
Explicit placement for missing and null sort values.
QueryError
Failure to validate or completely execute one structured query.
SortDirection
Sort direction for one field.
Value
Canonical structured value used by the deterministic reference executor.

Constants§

DEFAULT_QUERY_SCAN_BYTES
Fixed aggregate key and canonical-document byte budget used by the compatibility-preserving query entry points.
MAX_DOCUMENT_BYTES
Maximum canonical document payload bytes.
MAX_DOCUMENT_DEPTH
Maximum nested array/object depth, with the root at depth zero.
MAX_DOCUMENT_NODES
Maximum values decoded from one document.

Traits§

MonotonicClock
Injectable monotonic clock used to make timeout semantics testable.

Functions§

decode_document
Verifies and decodes one canonical binary document.
encode_document
Encodes one structured value into a checksummed canonical binary document.
encoded_document_len
Returns the exact canonical envelope length without allocating the encoded document.
execute
Executes one query over complete logical shards using the system clock.
execute_with_byte_limit
Executes one query under an explicit aggregate key/document byte budget.
execute_with_clock
Executes one query with an injectable monotonic clock.
execute_with_clock_and_byte_limit
Executes one query with an injectable monotonic clock and explicit aggregate key/document byte budget.
validate_query
Validates query shape and cursor canonicality without scanning records.