Skip to main content

Crate camel_component_api

Crate camel_component_api 

Source
Expand description

camel-component-api — traits and types for building Camel components.

Provides the core abstractions (Component, Endpoint, Consumer, Producer) that every rust-camel component implements. Also re-exports commonly-used types from camel-api and camel-endpoint for component convenience.

Main types: Component, Endpoint, Consumer, ProducerContext, ExchangeEnvelope, ComponentBundle, PollingConsumer. Main modules: component, endpoint, consumer, producer, registrar.

Re-exports§

pub use bundle::ComponentBundle;
pub use component::Component;
pub use component_context::ComponentContext;
pub use component_context::NoOpComponentContext;
pub use consumer::ConcurrencyModel;
pub use consumer::Consumer;
pub use consumer::ConsumerContext;
pub use consumer::ExchangeEnvelope;
pub use consumer::SecurityContext;
pub use endpoint::Endpoint;
pub use endpoint::PollingConsumer;
pub use health_registry::HealthCheckRegistry;
pub use health_registry::NoOpHealthCheckRegistry;
pub use health_registry::noop_health_check_registry;
pub use runtime_observability::RuntimeObservability;
pub use network_retry::NetworkRetryPolicy;
pub use network_retry::is_retryable_camel_error;
pub use network_retry::retry_async;
pub use network_retry::retry_async_cancelable;
pub use registrar::ComponentRegistrar;

Modules§

bundle
component
component_context
consumer
endpoint
health_registry
Narrow HealthCheckRegistry trait exposed to components via RuntimeObservability::health().
network_retry
Shared reconnection/backoff policy for networked components.
producer
Producer context for dependency injection.
registrar
runtime_observability
RuntimeObservability — narrow trait exposing metrics() and health() to Endpoint consumers/producers. Defined per ADR-0012 §Signal-replacement-API and the Phase A closure spec (docs/superpowers/specs/2026-06-05-adr-0012-closure-design.md).
uri

Structs§

CheckResult
Exchange
An Exchange represents a message being routed through the framework.
Message
A message flowing through the Camel framework.
ProducerContext
Context provided to producers for dependency injection.
StreamBody
A body that wraps a lazy-evaluated stream of bytes.
StreamMetadata
Metadata associated with a stream body.
UriComponents
Parsed components of a Camel URI.

Enums§

Body
The body of a message, supporting common payload types.
BodyType
Target type for body conversion.
CamelError
Core error type for the Camel framework.
HealthStatus
Aggregated system health status.
RouteAction
Represents actions that can be performed on a route.
RouteStatus
Represents the current lifecycle status of a route.
RuntimeCommand
RuntimeCommandResult
RuntimeQuery
RuntimeQueryResult

Traits§

AsyncHealthCheck
RuntimeCommandBus
RuntimeHandle
RuntimeQueryBus
UriConfig
Trait for configuration types that can be parsed from Camel URIs.

Functions§

parse_uri
Parse a Camel-style URI into its components.

Type Aliases§

BoxProcessor
A type-erased, cloneable processor. This is the main runtime representation of a processor pipeline — a composed chain of Tower Services erased to a single boxed type.
Value
Value type alias for dynamic header/property values.

Derive Macros§

UriConfig
Derive macro for UriConfig trait implementation.