Struct PlatformSourceConfig 

pub struct PlatformSourceConfig {
    pub redis_url: String,
    pub stream_key: String,
    pub consumer_group: String,
    pub consumer_name: Option<String>,
    pub batch_size: usize,
    pub block_ms: u64,
}

Platform source configuration for Redis Streams consumption.

This configuration defines how the platform source connects to Redis and consumes events from a stream using consumer groups.

Example

use drasi_source_platform::PlatformSourceConfig;

let config = PlatformSourceConfig {
    redis_url: "redis://localhost:6379".to_string(),
    stream_key: "my-app-changes".to_string(),
    consumer_group: "my-consumers".to_string(),
    consumer_name: Some("consumer-1".to_string()),
    batch_size: 50,
    block_ms: 10000,
};

YAML Configuration

source_type: platform
properties:
  redis_url: "redis://localhost:6379"
  stream_key: "my-app-changes"
  consumer_group: "my-consumers"
  batch_size: 50
  block_ms: 10000

Fields

redis_url: String

Redis connection URL.

Standard Redis connection string format.

Examples

• redis://localhost:6379 - Local Redis without auth
• redis://:password@host:6379 - Redis with password
• redis://user:password@host:6379 - Redis with username and password
• rediss://host:6379 - Redis with TLS

stream_key: String

Redis stream key to consume from.

This is the name of the Redis stream that contains the CloudEvent-wrapped change events. The stream must exist or will be created automatically when the consumer group is created with MKSTREAM.

consumer_group: String

Consumer group name.

All source instances with the same consumer group share the workload. Each message is delivered to only one consumer in the group.

Default: "drasi-core"

consumer_name: Option<String>

Consumer name (unique within group).

Identifies this specific consumer instance within the consumer group. If not specified, a unique name is auto-generated based on the source ID.

Default: Auto-generated from source ID

batch_size: usize

Number of events to read per XREADGROUP call.

Higher values improve throughput but increase memory usage and may delay processing of individual events.

Default: 100

Valid range: 1-10000 (recommended)

block_ms: u64

Milliseconds to block waiting for new events.

When no events are available, the consumer blocks for this duration before returning an empty result. Higher values reduce CPU usage but increase latency for detecting source shutdown.

Default: 5000 (5 seconds)

Valid range: 100-60000 (recommended)

Implementations

impl PlatformSourceConfig

pub fn validate(&self) -> Result<()>

Validate the configuration.

Errors

Returns an error if:

• redis_url is empty
• stream_key is empty
• consumer_group is empty
• batch_size is 0

Trait Implementations

impl Clone for PlatformSourceConfig

fn clone(&self) -> PlatformSourceConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PlatformSourceConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlatformSourceConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PlatformSourceConfig

fn eq(&self, other: &PlatformSourceConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PlatformSourceConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PlatformSourceConfig