Struct SubscriptionDefinition 

pub struct SubscriptionDefinition {
    pub name: String,
    pub return_type: String,
    pub arguments: Vec<ArgumentDefinition>,
    pub description: Option<String>,
    pub topic: Option<String>,
    pub filter: Option<SubscriptionFilter>,
    pub fields: Vec<String>,
    pub filter_fields: Vec<String>,
    pub deprecation: Option<DeprecationInfo>,
}

A subscription definition.

Subscriptions are declarative bindings to event topics.

Fields

name: String

Subscription name.

return_type: String

Return type name.

arguments: Vec<ArgumentDefinition>

Arguments.

description: Option<String>

Description.

topic: Option<String>

Event topic to subscribe to.

filter: Option<SubscriptionFilter>

Compiled filter expression for event matching. Maps argument names to JSONB paths in event data. Example: {"orderId": "$.id", "status": "$.order_status"}

fields: Vec<String>

Fields to project from event data. If empty, all fields are returned.

filter_fields: Vec<String>

Shorthand: argument names that should auto-generate argument_paths entries using /<field_name> as the JSON pointer path.

Example: filter_fields: ["user_id"] generates an argument_paths entry of "user_id" -> "/user_id" at runtime.

deprecation: Option<DeprecationInfo>

Deprecation information (from @deprecated directive). When set, this subscription is marked as deprecated in the schema.

Implementations

impl SubscriptionDefinition

pub fn new(name: impl Into<String>, return_type: impl Into<String>) -> Self

Create a new subscription definition.

pub fn with_topic(self, topic: impl Into<String>) -> Self

Set the event topic for this subscription.

Example

use fraiseql_core::schema::SubscriptionDefinition;

let subscription = SubscriptionDefinition::new("orderCreated", "Order")
    .with_topic("order_created");
assert_eq!(subscription.topic, Some("order_created".to_string()));

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description for this subscription.

pub fn with_argument(self, arg: ArgumentDefinition) -> Self

Add an argument to this subscription.

pub fn with_filter(self, filter: SubscriptionFilter) -> Self

Set the filter configuration for event matching.

pub fn with_fields(self, fields: Vec<String>) -> Self

Set the fields to project from event data.

pub fn with_field(self, field: impl Into<String>) -> Self

Add a field to project from event data.

pub fn deprecated(self, reason: Option<String>) -> Self

Mark this subscription as deprecated.

Example

use fraiseql_core::schema::SubscriptionDefinition;

let subscription = SubscriptionDefinition::new("oldUserEvents", "User")
    .deprecated(Some("Use 'userEvents' instead".to_string()));
assert!(subscription.is_deprecated());

pub const fn is_deprecated(&self) -> bool

Check if this subscription is deprecated.

pub fn deprecation_reason(&self) -> Option<&str>

Get the deprecation reason if deprecated.

Trait Implementations

impl Clone for SubscriptionDefinition

fn clone(&self) -> SubscriptionDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SubscriptionDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SubscriptionDefinition

fn eq(&self, other: &SubscriptionDefinition) -> 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 SubscriptionDefinition

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 SubscriptionDefinition