Struct ShapeDefinition 

pub struct ShapeDefinition {
    pub shape_id: String,
    pub tenant_id: u32,
    pub shape_type: ShapeType,
    pub description: String,
    pub field_filter: Vec<String>,
}

A shape definition: describes which data falls within the subscription.

Fields

shape_id: String

Unique shape ID.

tenant_id: u32

Tenant scope.

shape_type: ShapeType

Shape type with parameters.

description: String

Human-readable description (for debugging).

field_filter: Vec<String>

Optional field filter: only sync these fields (empty = all fields). Enables selective field-level sync instead of full document sync.

Implementations

impl ShapeDefinition

pub fn could_match(&self, collection: &str, _doc_id: &str) -> bool

Check if a mutation on a specific collection/document might match this shape.

This is a fast pre-check — returns true if the mutation COULD match. Actual predicate evaluation happens separately for document shapes. Returns false for ShapeType::Array (use matches_array_op instead).

pub fn matches_array_op(&self, array: &str, coord: &[u64]) -> bool

Check if an array op on array at coord matches this shape.

Returns false for non-Array shape types — use could_match for those. coord is the raw dimension values cast to u64 (unsigned index space).

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

Get the primary collection for this shape (if applicable).

Trait Implementations

impl Archive for ShapeDefinition

where String: Archive, u32: Archive, ShapeType: Archive, Vec<String>: 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 = ArchivedShapeDefinition

The archived representation of this type.

type Resolver = ShapeDefinitionResolver

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 ShapeDefinition

fn clone(&self) -> ShapeDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShapeDefinition

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<ShapeDefinition, __D> for Archived<ShapeDefinition>

where String: Archive, <String as Archive>::Archived: Deserialize<String, __D>, u32: Archive, <u32 as Archive>::Archived: Deserialize<u32, __D>, ShapeType: Archive, <ShapeType as Archive>::Archived: Deserialize<ShapeType, __D>, Vec<String>: Archive, <Vec<String> as Archive>::Archived: Deserialize<Vec<String>, __D>,

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

Deserializes using the given deserializer

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for ShapeDefinition

fn read<R: Read<'__msgpack_de>>(reader: &mut R) -> Result<Self, Error>

where Self: Sized,

Reads the MessagePack representation of this value from the provided reader.

impl<__S: Fallible + ?Sized> Serialize<__S> for ShapeDefinition

where String: Serialize<__S>, u32: Serialize<__S>, ShapeType: Serialize<__S>, Vec<String>: 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 ShapeDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToMessagePack for ShapeDefinition

fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes the MessagePack representation of this value into the provided writer.