open-feature-flagd 0.2.1

The official flagd provider for OpenFeature.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

pub mod file;
pub mod grpc;

pub use file::FileConnector;
pub use grpc::GrpcStreamConnector;

use std::collections::HashMap;
use std::sync::Arc;
use tokio::sync::Mutex;
use tokio::sync::mpsc::Receiver;

/// Payload sent through the connector stream containing flag data or errors
#[derive(Debug, Clone)]
pub struct QueuePayload {
    /// Type of payload (Data or Error)
    pub payload_type: QueuePayloadType,
    /// Flag configuration data (JSON string) or error message
    pub flag_data: String,
    /// Optional metadata associated with the sync
    pub metadata: Option<HashMap<String, serde_json::Value>>,
}

/// Type of payload in the queue
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum QueuePayloadType {
    /// Successful data payload
    Data,
    /// Error payload
    Error,
}

use crate::error::FlagdError;

/// Trait for flag configuration connectors (gRPC, file, etc.)
///
/// Connectors are responsible for fetching flag configurations from external sources
/// and providing them as a stream of payloads. Implementations must be thread-safe
/// (Send + Sync) as they may be used in async contexts.
#[async_trait::async_trait]
pub trait Connector: Send + Sync {
    /// Initialize the connector and start fetching data
    async fn init(&self) -> Result<(), FlagdError>;

    /// Gracefully shutdown the connector and release resources
    async fn shutdown(&self) -> Result<(), FlagdError>;

    /// Get the stream of payloads from this connector
    fn get_stream(&self) -> Arc<Mutex<Option<Receiver<QueuePayload>>>>;
}