Expand description
Traits and structs for component API and internals
Structs§
- Blocking
Future - A future that is supposed to be blocking the component’s execution until completed
- Component
- A concrete component instance
- Component
Context - The contextual object for a Kompact component
- Component
Core - The core of a Kompact component
- Component
Definition Access - Gives access to the component definition within a future/async function
- Component
Fault - A component-local fault produced by a handler.
- Context
System Handle - The SystemHandle provided by a ComponentContext
- Execute
Result - Statistics about the last invocation of execute.
- Lock
Poisoned - Error for when the component definition lock has been poisoned
- NonBlocking
Future - A future that is supposed to be polled while the component is running normally
Enums§
- Handled
- State transition indication at the end of a message or event handler.
- Handler
Error - An abnormal result returned from a component handler.
- Scheduling
Decision - Indicates whether or not a component should be sent to the Scheduler
Traits§
- Abstract
Component - An object-safe trait that exposes most of functionality of a
Componentthat isn’t dependent on a particularComponentDefinition. - Component
Definition - The core trait every component must implement
- Component
Lifecycle - A trait to customise handling of lifecycle events
- Component
Logging - An abstraction over providers of Kompact loggers
- Component
Traits - A trait bound alias for the trait required by the generic parameter of a Component
- Core
Container - A trait for abstracting over structures that contain a component core
- Dynamic
Component Definition - Object-safe part of
ComponentDefinition. - Dynamic
Port Access - A mechanism for dynamically getting references to provided/required ports from a component.
- Handler
Result Ext - Extension helpers for classifying fallible results in component handlers.
- Locking
Provide Ref - Same as ProvideRef, but for instances that must be locked first
- Locking
Require Ref - Same as RequireRef, but for instances that must be locked first
- MsgQueue
Container - Anything with this trait can be turned into an ActorRef as long as its behind an Arc or Weak
- Provide
- A trait implementing handling of provided events of
P - Provide
Ref - A convenience abstraction over concrete port instance fields
- Require
- A trait implementing handling of required events of
P - Require
Ref - A convenience abstraction over concrete port instance fields
- Unique
Registrable - A trait for component views that can be used for unique actor registration
Functions§
- default_
recovery_ function - Kompact’s default fault recovery policy is to simply ignore the fault
Type Aliases§
- Boxed
Handler Error - A boxed error returned from a Kompact handler.
- Dynamic
Component Definition Mutex Guard - Mutex guard guarding a
DynamicComponentDefinitiontrait object. - Handler
Result - The result returned from component handlers.