Struct Subscription 

pub struct Subscription {
    pub entity: String,
    pub filter: Option<Filter>,
    pub fields: Option<Vec<String>>,
    pub include_relations: bool,
}

A subscription request for change notifications.

Fields

entity: String

The entity type to watch for changes.

filter: Option<Filter>

Optional filter to limit which changes are sent.

fields: Option<Vec<String>>

Optional list of fields to include in change notifications.

include_relations: bool

Include related entity changes.

Implementations

impl Subscription

pub fn new(entity: impl Into<String>) -> Self

Create a new subscription for an entity.

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

Add a filter to the subscription.

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

Specify which fields to include in change notifications.

pub fn with_relations(self) -> Self

Include related entity changes.

Trait Implementations

impl Archive for Subscription

where String: Archive, Option<Filter>: Archive, Option<Vec<String>>: Archive, bool: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedSubscription

The archived representation of this type.

type Resolver = SubscriptionResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Subscription

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<Subscription, __D> for Archived<Subscription>

where String: Archive, <String as Archive>::Archived: Deserialize<String, __D>, Option<Filter>: Archive, <Option<Filter> as Archive>::Archived: Deserialize<Option<Filter>, __D>, Option<Vec<String>>: Archive, <Option<Vec<String>> as Archive>::Archived: Deserialize<Option<Vec<String>>, __D>, bool: Archive, <bool as Archive>::Archived: Deserialize<bool, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<Subscription, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl PartialEq for Subscription

fn eq(&self, other: &Subscription) -> 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<__S: Fallible + ?Sized> Serialize<__S> for Subscription

where String: Serialize<__S>, Option<Filter>: Serialize<__S>, Option<Vec<String>>: Serialize<__S>, bool: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for Subscription

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 Subscription