#![forbid(unsafe_code)]
#[doc(hidden)]
mod codec;
mod date;
mod decimal;
mod defaults;
mod float;
mod key;
mod managed;
mod primary;
mod schema;
mod store;
mod store_key;
mod time;
mod types;
mod ulid;
#[cfg(all(feature = "build", not(target_arch = "wasm32")))]
pub mod build;
#[cfg(all(feature = "test-support", not(target_arch = "wasm32")))]
pub mod testing;
#[doc(hidden)]
#[cfg(not(all(feature = "build", not(target_arch = "wasm32"))))]
#[macro_export]
macro_rules! __register_schema {
($($item:item)*) => {};
}
pub use date::Date;
pub use decimal::{Decimal, ParseDecimalError};
pub use defaults::{InsertInput, LiteralDefault};
pub use ethnum::U256;
pub use float::{Float32, Float64};
pub use ic_db_macros::{entity, enum_, list, map, newtype, record, set};
pub use ic_platform_types::{Account, Principal, Subaccount};
pub use key::IndexValue;
pub use managed::ManagedTimestamp;
pub use primary::PrimaryKey;
pub use time::{Duration, TimeParseError, Timestamp};
pub use ulid::{
SeededUlidGenerator, Ulid, UlidEntropyError, UlidGenerationError, UlidGenerator, UlidParseError,
};
pub type Blob = Vec<u8>;
pub use schema::{EntitySchema, FieldSchema, FieldType, IndexSchema, ReferenceSchema, Schema};
pub use store::{
Aggregate, Batch, Comparison, CopyStep, GroupCount, GroupCursor, GroupOrder, GroupPage,
GroupValue, JobHandle, JobOutcome, JobStep, Page, QueryCursor, QueryOperand, QueryPage,
SchemaTransition, SortDirection,
};
pub type Database = store::Database<ic_storage::DefaultMemoryImpl>;
pub type Query<'a, E> = store::Query<'a, E, ic_storage::DefaultMemoryImpl>;
pub type Maintenance = store::Maintenance<ic_storage::DefaultMemoryImpl>;
pub type AggregateJobs = store::AggregateJobs<ic_storage::DefaultMemoryImpl>;
pub type SchemaCopy = store::SchemaCopy<ic_storage::DefaultMemoryImpl>;
pub type RetiredSource = store::RetiredSource<ic_storage::DefaultMemoryImpl>;
#[cfg(any(doc, feature = "test-support"))]
pub mod qualification {
pub use crate::store::{
AggregateJobs, Database, Maintenance, Query, RetiredSource, SchemaCopy,
};
}
pub use store_key::MAX_INDEX_KEY_BYTES;
#[derive(Debug)]
pub enum Error {
Maintenance,
InvalidTransition,
InvalidJob,
JobCapacity,
ArithmeticOverflow,
InvalidQuery,
MultipleMatches,
InvalidCursor,
RowTooLarge,
MissingOperationTime,
ManagedField,
TimestampRegression,
MissingField(&'static str),
InvalidSchema,
InvalidOperand,
UnknownEntity,
IncompatibleSchema,
Corrupt,
Exists,
Missing,
DuplicateTarget,
UniqueViolation,
ReferenceViolation,
Limit,
}
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{self:?}")
}
}
impl std::error::Error for Error {}
pub use types::{TypeBody, TypeLink, TypeSchema, Value, ValueSchema, VariantSchema};
pub mod design {
pub mod prelude {
pub use crate::{
Account, Blob, Date, Decimal, Duration, Float32, Float64, Principal, Subaccount,
Timestamp, U256, Ulid,
};
pub use crate::{Entity, Schema, Value};
pub use crate::{entity, enum_, list, map, newtype, record, set};
}
}
pub trait Entity: Sized {
type Key: PrimaryKey;
fn declaration_path() -> &'static str;
const SCHEMA: &'static EntitySchema;
fn key(&self) -> Self::Key;
#[doc(hidden)]
fn __row_info(&self) -> __private::RowInfo;
fn validate(&self) -> Result<(), Error>;
fn encode(&self) -> Result<Vec<u8>, Error>;
fn decode(bytes: &[u8]) -> Result<Self, Error>;
}
#[doc(hidden)]
pub mod __private {
pub trait ReferenceTarget {
const NAME: &'static str;
}
pub use crate::codec::{Decoder, Encoder, MAX_ROW_BYTES};
pub use crate::key::encode_index;
pub use crate::managed::validate_order as validate_managed_order;
pub use crate::primary::RowKey;
pub use crate::schema::handle;
pub struct RowInfo {
pub key: RowKey,
pub indexes: Vec<Option<Vec<u8>>>,
}
}