reifydb-core 0.4.11

Core database interfaces and data structures for ReifyDB
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

use std::ops::Deref;

use reifydb_type::{error::Error, value::frame::frame::Frame};

use crate::metric::ExecutionMetrics;

/// Result of executing one or more RQL statements.
///
/// Metrics and frames are **always** present — even when execution fails.
/// On failure, `error` holds the cause while `frames` contains partial output
/// (whatever succeeded before the failure) and `metrics` holds partial telemetry.
///
/// Derefs to `[Frame]` so callers can index, iterate, or check `.is_empty()`
/// directly while still accessing `.metrics` for telemetry.
#[derive(Debug)]
pub struct ExecutionResult {
	pub frames: Vec<Frame>,
	pub error: Option<Error>,
	pub metrics: ExecutionMetrics,
}

impl ExecutionResult {
	/// Returns `true` if the execution completed without error.
	pub fn is_ok(&self) -> bool {
		self.error.is_none()
	}

	/// Returns `true` if the execution failed.
	pub fn is_err(&self) -> bool {
		self.error.is_some()
	}

	/// Convert to a `Result`, enabling the `?` operator.
	///
	/// Returns `Ok(self)` when there is no error, `Err(e)` otherwise.
	/// The `Ok` variant retains full access to frames and metrics.
	pub fn check(self) -> Result<Self, Error> {
		match self.error {
			Some(e) => Err(e),
			None => Ok(self),
		}
	}
}

impl Deref for ExecutionResult {
	type Target = [Frame];

	fn deref(&self) -> &[Frame] {
		&self.frames
	}
}