xds-core 0.1.0

Core types, traits, and error handling for xDS control plane
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

//! # xds-core
//!
//! Core types, traits, and error handling for xDS control plane implementations.
//!
//! This crate provides the foundational types used across all other xDS crates:
//!
//! - [`XdsError`] - Comprehensive error type with proper gRPC status code mapping
//! - [`ResourceVersion`] - Version tracking for xDS resources
//! - [`NodeHash`] - Efficient node identification using FNV-1a hashing
//! - [`Resource`] - Trait for implementing custom xDS resource types
//! - [`TypeUrl`] - Type URL handling and constants
//!
//! ## Example
//!
//! ```rust
//! use xds_core::{XdsError, NodeHash, ResourceVersion};
//!
//! // Create a node hash from a node ID
//! let node = NodeHash::from_id("my-envoy-node");
//!
//! // Create a resource version
//! let version = ResourceVersion::new("v1");
//!
//! // Check if version is empty (initial state)
//! assert!(!version.is_empty());
//! ```

#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(unsafe_code)]
#![warn(missing_docs)]
// Tests are allowed to use .unwrap() / .expect() / panic! freely; the
// production-only warnings still apply.
#![cfg_attr(test, allow(clippy::unwrap_used, clippy::expect_used, clippy::panic))]

mod error;
mod node;
mod resource;
mod type_url;
mod version;

pub use error::XdsError;
pub use node::NodeHash;
pub use resource::{
    BoxResource, Resource, ResourceRegistry, ResourceTypeInfo, SharedResourceRegistry,
};
pub use type_url::TypeUrl;
pub use version::ResourceVersion;

/// Result type alias using [`XdsError`].
pub type Result<T> = std::result::Result<T, XdsError>;

/// Alias for Result to maintain backward compatibility.
pub type XdsResult<T> = Result<T>;