cf-types-registry-sdk 0.2.1

SDK for types-registry module: API trait, GTS entity types, and error definitions
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

//! Types Registry SDK
//!
//! This crate provides the public API for the `types-registry` module:
//! - `TypesRegistryClient` trait for inter-module communication
//! - `GtsTypeSchema` / `GtsInstance` typed entity models
//! - `TypeSchemaQuery` / `InstanceQuery` for filtering
//! - `GtsTypeId` / `GtsInstanceId` typed identifiers
//! - `TypesRegistryError` for error handling
//!
//! ## Usage
//!
//! Consumers obtain the client from `ClientHub`:
//! ```ignore
//! use types_registry_sdk::{TypeSchemaQuery, TypesRegistryClient};
//!
//! let client = hub.get::<dyn TypesRegistryClient>()?;
//!
//! let schema = client.get_type_schema("gts.acme.core.events.user.v1~").await?;
//! let schemas = client
//!     .list_type_schemas(TypeSchemaQuery::default().with_pattern("gts.acme.*"))
//!     .await?;
//! ```

#![forbid(unsafe_code)]
#![deny(rust_2018_idioms)]

pub mod api;
pub mod error;
pub mod models;

#[cfg(feature = "test-util")]
pub mod testing;

pub use api::TypesRegistryClient;
pub use error::TypesRegistryError;
pub use models::{
    GtsInstance, GtsTypeId, GtsTypeSchema, InstanceQuery, RegisterResult, RegisterSummary,
    TypeSchemaQuery, is_type_schema_id,
};

// Re-export the underlying gts identifier types so consumers don't need a
// direct dependency on `gts` for typed IDs.
pub use gts::GtsInstanceId;