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 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
//! The public API for both compute and storage.
#![warn(missing_docs)]
use std::fmt;
use std::str::FromStr;
use std::sync::Arc;
use std::time::Duration;
use anyhow::bail;
use serde::{Deserialize, Serialize};
pub mod client;
pub mod metrics;
/// A function that computes the lag between the given time and wallclock time.
pub type WallclockLagFn<T> = Arc<dyn Fn(&T) -> Duration + Send + Sync>;
/// Identifier of a replica.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum ReplicaId {
/// A user replica.
User(u64),
/// A system replica.
System(u64),
}
impl ReplicaId {
/// Return the inner numeric ID value.
pub fn inner_id(&self) -> u64 {
match self {
ReplicaId::User(id) => *id,
ReplicaId::System(id) => *id,
}
}
/// Whether this value identifies a user replica.
pub fn is_user(&self) -> bool {
matches!(self, Self::User(_))
}
/// Whether this value identifies a system replica.
pub fn is_system(&self) -> bool {
matches!(self, Self::System(_))
}
}
impl fmt::Display for ReplicaId {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
Self::User(id) => write!(f, "u{}", id),
Self::System(id) => write!(f, "s{}", id),
}
}
}
impl FromStr for ReplicaId {
type Err = anyhow::Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let first = s.chars().next();
let rest = s.get(1..);
if let (Some(prefix), Some(num)) = (first, rest) {
let id = num.parse()?;
match prefix {
'u' => return Ok(Self::User(id)),
's' => return Ok(Self::System(id)),
_ => (),
}
}
bail!("invalid replica ID: {}", s);
}
}