Skip to main content

PlatformSource

Struct PlatformSource 

Source
pub struct PlatformSource { /* private fields */ }
Expand description

Platform source that reads events from Redis Streams.

This source connects to a Redis instance and consumes CloudEvent-wrapped messages from a stream using consumer groups. It supports both data events (node/relation changes) and control events (query subscriptions).

§Fields

  • base: Common source functionality (dispatchers, status, lifecycle)
  • config: Platform-specific configuration (Redis connection, stream settings)

Implementations§

Source§

impl PlatformSource

Source

pub fn builder(id: impl Into<String>) -> PlatformSourceBuilder

Create a builder for PlatformSource

§Example
use drasi_source_platform::PlatformSource;

let source = PlatformSource::builder("my-platform-source")
    .with_redis_url("redis://localhost:6379")
    .with_stream_key("my-changes")
    .with_bootstrap_provider(my_provider)
    .build()?;
Source

pub fn new(id: impl Into<String>, config: PlatformSourceConfig) -> Result<Self>

Create a new platform source.

The event channel is automatically injected when the source is added to DrasiLib via add_source().

§Arguments
  • id - Unique identifier for this source instance
  • config - Platform source configuration
§Returns

A new PlatformSource instance, or an error if construction fails.

§Errors

Returns an error if the base source cannot be initialized.

§Example
use drasi_source_platform::{PlatformSource, PlatformSourceBuilder};

let config = PlatformSourceBuilder::new("my-platform-source")
    .with_redis_url("redis://localhost:6379")
    .with_stream_key("my-changes")
    .build()?;
Source§

impl PlatformSource

Source

pub fn test_subscribe(&self) -> Box<dyn ChangeReceiver<SourceEventWrapper>>

Create a test subscription to this source (synchronous)

This method delegates to SourceBase and is provided for convenience in tests. Note: Use test_subscribe_async() in async contexts to avoid runtime issues.

Source

pub async fn test_subscribe_async( &self, ) -> Box<dyn ChangeReceiver<SourceEventWrapper>>

Create a test subscription to this source (async)

This method delegates to SourceBase and is provided for convenience in async tests. Prefer this method over test_subscribe() in async contexts.

Trait Implementations§

Source§

impl Source for PlatformSource

Source§

fn id(&self) -> &str

Get the source’s unique identifier
Source§

fn type_name(&self) -> &str

Get the source type name (e.g., “postgres”, “http”, “mock”)
Source§

fn properties(&self) -> HashMap<String, Value>

Get the source’s configuration properties for inspection Read more
Source§

fn auto_start(&self) -> bool

Whether this source should auto-start when DrasiLib starts Read more
Source§

fn start<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Start the source Read more
Source§

fn stop<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Stop the source Read more
Source§

fn status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ComponentStatus> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get the current status of the source
Source§

fn subscribe<'life0, 'async_trait>( &'life0 self, settings: SourceSubscriptionSettings, ) -> Pin<Box<dyn Future<Output = Result<SubscriptionResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Subscribe to this source for change events Read more
Source§

fn as_any(&self) -> &dyn Any

Downcast helper for testing - allows access to concrete types
Source§

fn initialize<'life0, 'async_trait>( &'life0 self, context: SourceRuntimeContext, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Initialize the source with runtime context. Read more
Source§

fn set_bootstrap_provider<'life0, 'async_trait>( &'life0 self, provider: Box<dyn BootstrapProvider + 'static>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Set the bootstrap provider for this source Read more
Source§

fn dispatch_mode(&self) -> DispatchMode

Get the dispatch mode for this source (Channel or Broadcast) Read more
Source§

fn deprovision<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Permanently clean up internal state when the source is being removed. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more