citadel_types 0.13.0

Types for the citadel protocol
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
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

//! # Citadel Types
//!
//! Core type definitions and utilities for the Citadel Protocol.
//! This crate provides fundamental types, error definitions, and utilities
//! used throughout the Citadel Protocol ecosystem.
//!
//! ## Core Modules
//!
//! - **crypto**: Cryptographic types and utilities
//!   - Secure memory buffers
//!   - Cryptographic parameters
//!   - Algorithm definitions
//!   - Security level specifications
//!
//! - **errors**: Error types and handling
//!   - Protocol-specific errors
//!   - Error conversion traits
//!   - Result type aliases
//!
//! - **proto**: Protocol-specific types
//!   - Message definitions
//!   - Protocol constants
//!   - Serialization formats
//!
//! - **user**: User-related types
//!   - User identifiers
//!   - Authentication data
//!   - Session information
//!
//! - **utils**: General utilities
//!   - Validation functions
//!   - Helper traits
//!   - Common constants
//!
//! ## Usage
//!
//! The crate provides a prelude module for convenient imports:
//!
//! ```rust
//! use citadel_types::prelude::*;
//!
//! // Use crypto types
//! let secure_buffer = SecBuffer::empty();
//! let params = CryptoParameters::default();
//! ```
//!
//! ## Features
//!
//! - Memory-secure types for sensitive data
//! - Comprehensive error handling
//! - Serialization support via serde
//! - Validation utilities
//! - Type-safe protocol definitions

#![allow(non_camel_case_types)]

/// Common imports for working with Citadel types.
///
/// This module re-exports the most commonly used types from the crate's
/// modules, providing a convenient way to import multiple items at once.
pub mod prelude {
    pub use crate::crypto::*;
    pub use crate::proto::*;
    pub use crate::user::*;
}

/// Cryptographic types and utilities.
pub mod crypto;

/// Error types and handling.
pub mod errors;

/// Protocol-specific message and data types.
pub mod proto;

/// User-related types and data structures.
pub mod user;

/// General utility functions and helpers.
pub mod utils;