Skip to main content

camel_component_api/
lib.rs

1//! camel-component-api — traits and types for building Camel components.
2//!
3//! Provides the core abstractions (`Component`, `Endpoint`, `Consumer`, `Producer`)
4//! that every rust-camel component implements. Also re-exports commonly-used types
5//! from `camel-api` and `camel-endpoint` for component convenience.
6//!
7//! Main types: `Component`, `Endpoint`, `Consumer`, `ProducerContext`, `ExchangeEnvelope`, `ComponentBundle`, `PollingConsumer`.
8//! Main modules: `component`, `endpoint`, `consumer`, `producer`, `registrar`.
9
10pub mod bundle;
11pub mod component;
12pub mod component_context;
13pub mod consumer;
14pub mod endpoint;
15pub mod health_registry;
16pub mod runtime_observability;
17
18pub mod cron_service;
19pub mod network_retry;
20pub mod producer;
21pub mod registrar;
22#[cfg(any(test, feature = "test-support"))]
23pub mod test_support;
24pub mod tls_source;
25
26pub use bundle::ComponentBundle;
27pub use component::Component;
28pub use component_context::{ComponentContext, NoOpComponentContext};
29pub use consumer::{
30    ConcurrencyModel, Consumer, ConsumerContext, ExchangeEnvelope, SecurityContext,
31};
32pub use endpoint::{Endpoint, PollingConsumer};
33pub use health_registry::{
34    HealthCheckRegistry, NoOpHealthCheckRegistry, noop_health_check_registry,
35};
36pub use runtime_observability::RuntimeObservability;
37
38pub use cron_service::{CronCallback, CronFire, CronSchedule, CronService};
39pub use network_retry::{
40    NetworkRetryPolicy, is_retryable_camel_error, retry_async, retry_async_cancelable,
41};
42pub use producer::ProducerContext;
43pub use registrar::ComponentRegistrar;
44#[cfg(any(test, feature = "test-support"))]
45pub use test_support::{NoopRuntimeObservability, PanicRuntimeObservability};
46
47// Re-export camel-api types for component convenience
48pub use camel_api::{
49    AsyncHealthCheck, Body, BodyType, BoxProcessor, CamelError, CheckResult, Exchange,
50    HealthStatus, Message, RouteAction, RouteStatus, RuntimeCommand, RuntimeCommandBus,
51    RuntimeCommandResult, RuntimeHandle, RuntimeQuery, RuntimeQueryBus, RuntimeQueryResult,
52    StreamBody, StreamMetadata, Value,
53};
54
55// Re-export camel-endpoint types for component convenience
56pub use camel_endpoint::{UriComponents, UriConfig, parse_uri};
57// Expose a `uri` sub-module so crates using `#[uri_config(crate = "camel_component_api")]`
58// can resolve `camel_component_api::uri::parse_bool_param` etc.
59pub mod uri {
60    /// Parse a boolean URI parameter value (case-insensitive).
61    /// Accepts: "true"/"1"/"yes" → true; "false"/"0"/"no" → false.
62    pub fn parse_bool_param(s: &str) -> Result<bool, String> {
63        match s.to_lowercase().as_str() {
64            "true" | "1" | "yes" => Ok(true),
65            "false" | "0" | "no" => Ok(false),
66            _ => Err(format!("invalid boolean value: '{}'", s)),
67        }
68    }
69}