Struct CollectionProxy 

pub struct CollectionProxy {
    pub relationship: String,
    pub attribute: String,
    pub unique: bool,
    pub deduplicate: bool,
    pub loading_strategy: Option<LoadingStrategy>,
    pub factory: Option<Arc<dyn ReflectableFactory>>,
    /* private fields */
}

Available on native and crate feature proxy and crate feature routing only.

Collection proxy for accessing multiple related objects’ attributes

Used for one-to-many and many-to-many relationships where the proxy returns a collection of scalar values.

Example

// User has many posts, access all post titles directly
let titles_proxy: CollectionProxy = CollectionProxy::new("posts", "title");
// let titles: Vec<String> = titles_proxy.get_values(&user).await?;

Fields

relationship: String

Name of the relationship

attribute: String

Name of the attribute on the related objects

unique: bool

Whether to remove duplicates

deduplicate: bool

Whether to deduplicate values

loading_strategy: Option<LoadingStrategy>

Loading strategy for the relationship

factory: Option<Arc<dyn ReflectableFactory>>

Factory for creating new instances from scalar values

Implementations

impl CollectionProxy

pub fn new(relationship: &str, attribute: &str) -> CollectionProxy

Available on crate feature test only.

Create a new collection proxy

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title");
assert_eq!(proxy.relationship, "posts");
assert_eq!(proxy.attribute, "title");
assert!(!proxy.unique);

pub fn unique(relationship: &str, attribute: &str) -> CollectionProxy

Available on crate feature test only.

Create a collection proxy that removes duplicates

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::unique("tags", "name");
assert_eq!(proxy.relationship, "tags");
assert_eq!(proxy.attribute, "name");
assert!(proxy.unique);

pub fn with_factory( relationship: &str, attribute: &str, factory: Arc<dyn ReflectableFactory>, ) -> CollectionProxy

Available on crate feature test only.

Create a collection proxy with a factory for creating instances

pub fn set_factory(&mut self, factory: Arc<dyn ReflectableFactory>)

Available on crate feature test only.

Set the factory for this proxy

pub async fn get_values<T>( &self, source: &T, ) -> Result<Vec<ScalarValue>, ProxyError>

where T: Reflectable,

Available on crate feature test only.

Get collection of values from related objects

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title");

pub async fn set_values<T>( &self, source: &mut T, values: Vec<ScalarValue>, ) -> Result<(), ProxyError>

where T: Reflectable,

Available on crate feature test only.

Set collection of values by creating/updating related objects

Examples

use reinhardt_urls::proxy::{CollectionProxy, ScalarValue};

let proxy = CollectionProxy::new("tags", "name");
let values = vec![ScalarValue::String("rust".to_string())];

pub async fn append<T>( &self, source: &mut T, value: ScalarValue, ) -> Result<(), ProxyError>

where T: Reflectable,

Available on crate feature test only.

Append a value to the collection

Examples

use reinhardt_urls::proxy::{CollectionProxy, ScalarValue};

let proxy = CollectionProxy::new("tags", "name");

pub async fn remove<T>( &self, source: &mut T, value: ScalarValue, ) -> Result<(), ProxyError>

where T: Reflectable,

Available on crate feature test only.

Remove a value from the collection

Examples

use reinhardt_urls::proxy::{CollectionProxy, ScalarValue};

let proxy = CollectionProxy::new("tags", "name");

pub async fn contains<T>( &self, source: &T, value: ScalarValue, ) -> Result<bool, ProxyError>

where T: Reflectable,

Available on crate feature test only.

Check if the collection contains a value

Examples

use reinhardt_urls::proxy::{CollectionProxy, ScalarValue};

let proxy = CollectionProxy::new("tags", "name");

pub async fn count<T>(&self, source: &T) -> Result<usize, ProxyError>

where T: Reflectable,

Available on crate feature test only.

Get the count of items in the collection

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title");

pub async fn filter<T>( &self, source: &T, condition: FilterCondition, ) -> Result<Vec<ScalarValue>, ProxyError>

where T: Reflectable,

Available on crate feature test only.

Filter collection by a condition on the proxy attribute

Examples

use reinhardt_urls::proxy::{CollectionProxy, query::{FilterCondition, FilterOp}};

let proxy = CollectionProxy::new("posts", "status");
let condition = FilterCondition::new("status", FilterOp::eq("published"));

pub async fn filter_by<T, F>( &self, source: &T, predicate: F, ) -> Result<Vec<ScalarValue>, ProxyError>

where T: Reflectable, F: Fn(&ScalarValue) -> bool,

Available on crate feature test only.

Filter collection using a custom predicate

Examples

use reinhardt_urls::proxy::{CollectionProxy, ScalarValue};

let proxy = CollectionProxy::new("posts", "views");

pub fn relationship(&self) -> &str

Available on crate feature test only.

Get the relationship name

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title");
assert_eq!(proxy.relationship(), "posts");

pub fn attribute(&self) -> &str

Available on crate feature test only.

Get the attribute name

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title");
assert_eq!(proxy.attribute(), "title");

pub fn is_unique(&self) -> bool

Available on crate feature test only.

Check if this proxy removes duplicates

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::unique("tags", "name");
assert!(proxy.is_unique());

let proxy2 = CollectionProxy::new("posts", "title");
assert!(!proxy2.is_unique());

pub fn deduplicates(&self) -> bool

Available on crate feature test only.

Check if this proxy deduplicates values

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("tags", "name").with_deduplication(true);
assert!(proxy.deduplicates());

pub fn with_unique(self, unique: bool) -> CollectionProxy

Available on crate feature test only.

Set whether to remove duplicates (builder pattern)

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("tags", "name").with_unique(true);
assert!(proxy.is_unique());

pub fn with_deduplication(self, deduplicate: bool) -> CollectionProxy

Available on crate feature test only.

Set whether to deduplicate values (builder pattern)

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("tags", "name").with_deduplication(true);
assert!(proxy.deduplicates());

pub fn with_loading_strategy(self, strategy: LoadingStrategy) -> CollectionProxy

Available on crate feature test only.

Set the loading strategy (builder pattern)

Examples

use reinhardt_urls::proxy::{CollectionProxy, LoadingStrategy};

let proxy = CollectionProxy::new("posts", "title")
    .with_loading_strategy(LoadingStrategy::Joined);

pub async fn filter_with_any<T>( &self, source: &T, field: &str, value: &str, ) -> Result<Vec<ScalarValue>, ProxyError>

where T: Reflectable,

Available on crate feature test only.

Filter collection where any item matches the condition

Returns a new proxy with filtered values where at least one item in the collection matches the specified field and value.

Examples

use reinhardt_urls::proxy::CollectionProxy;

// Example: Filter posts where any tag matches "rust"
// let proxy = CollectionProxy::new("posts", "tags");
// let filtered = proxy.filter_with_any("name", "rust").await?;

pub async fn filter_with_has<T>( &self, source: &T, relationship: &str, value: &str, ) -> Result<Vec<ScalarValue>, ProxyError>

where T: Reflectable,

Available on crate feature test only.

Filter collection where item has specific relationship

Filters the collection to include only items that have a specific relationship with the given value.

Examples

use reinhardt_urls::proxy::CollectionProxy;

// Example: Filter posts that have comments from "Alice"
// let proxy = CollectionProxy::new("posts", "title");
// let source = ...;
// let filtered = proxy.filter_with_has(&source, "comments", "Alice").await?;

pub fn with_cascade(self, cascade: bool) -> CollectionProxy

Available on crate feature test only.

Configure cascade behavior for related operations

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_cascade(true);
assert!(proxy.is_cascade());

pub async fn merge<T>( &self, source1: &T, other: &CollectionProxy, source2: &T, ) -> Result<Vec<ScalarValue>, ProxyError>

where T: Reflectable,

Available on crate feature test only.

Merge with another collection proxy

Merges two collection proxies by combining their values. Note: This operation requires both proxies to work on the same source object.

Examples

use reinhardt_urls::proxy::CollectionProxy;

// Merge values from two different relationships
// let proxy1 = CollectionProxy::new("posts", "title");
// let proxy2 = CollectionProxy::new("drafts", "title");
// let source = ...;
// let merged = proxy1.merge(&source, proxy2, &source).await?;

pub fn with_batch_size(self, batch_size: usize) -> CollectionProxy

Available on crate feature test only.

Set batch size for collection operations

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_batch_size(100);
assert_eq!(proxy.batch_size(), Some(100));

pub fn with_async_loading(self, async_loading: bool) -> CollectionProxy

Available on crate feature test only.

Enable async loading for collection

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_async_loading(true);

pub fn with_streaming(self, streaming: bool) -> CollectionProxy

Available on crate feature test only.

Enable streaming for large collections

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("logs", "message")
    .with_streaming(true);

pub fn with_caching(self, caching: bool) -> CollectionProxy

Available on crate feature test only.

Enable caching for collection queries

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_caching(true);

pub fn with_database(self, database: &str) -> CollectionProxy

Available on crate feature test only.

Configure database for collection operations

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_database("analytics");

pub fn with_memory_limit(self, memory_limit: usize) -> CollectionProxy

Available on crate feature test only.

Set memory limit for collection operations

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_memory_limit(1024 * 1024);
assert_eq!(proxy.memory_limit(), Some(1024 * 1024));

pub fn with_stored_procedure(self, procedure: &str) -> CollectionProxy

Available on crate feature test only.

Configure stored procedure for collection operations

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_stored_procedure("get_posts");

pub fn with_triggers(self, triggers: bool) -> CollectionProxy

Available on crate feature test only.

Configure triggers for collection operations

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_triggers(true);

pub fn with_version_tracking(self, version_tracking: bool) -> CollectionProxy

Available on crate feature test only.

Enable version tracking for collection items

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_version_tracking(true);
assert!(proxy.is_version_tracking());

pub async fn bulk_insert<T>( &self, source: &mut T, items: Vec<ScalarValue>, ) -> Result<(), ProxyError>

where T: Reflectable,

Available on crate feature test only.

Bulk insert multiple items into the collection

Inserts multiple scalar values into the collection by creating Reflectable objects using the configured factory.

Examples

use reinhardt_urls::proxy::{CollectionProxy, ScalarValue};

// Requires factory to be configured
// let proxy = CollectionProxy::with_factory("tags", "name", factory)
//     .with_batch_size(100);
// let mut source = ...;
// let values = vec![
//     ScalarValue::String("rust".to_string()),
//     ScalarValue::String("python".to_string()),
// ];
// proxy.bulk_insert(&mut source, values).await?;

pub async fn clear_on<T>(&self, source: &mut T) -> Result<(), ProxyError>

where T: Reflectable,

Available on crate feature test only.

Clear all items from the collection

Examples

use reinhardt_urls::proxy::CollectionProxy;

// Requires a mutable source object with Reflectable trait
// let mut source = ...;
// let proxy = CollectionProxy::new("tags", "name");
// proxy.clear_on(&mut source).await?;

pub fn is_view(&self) -> bool

Available on crate feature test only.

Check if this proxy targets a database view

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("user_view", "name")
    .with_view(true);
assert!(proxy.is_view());

pub fn with_view(self, is_view: bool) -> CollectionProxy

Available on crate feature test only.

Configure this proxy to target a database view

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("user_summary", "name")
    .with_view(true);
assert!(proxy.is_view());

pub async fn update_with_version<T>( &self, source: &mut T, value: ScalarValue, expected_version: i64, ) -> Result<(), ProxyError>

where T: Reflectable,

Available on crate feature test only.

Update items with version tracking

Updates collection items with optimistic locking based on version numbers. This method ensures that updates only succeed if the version matches, preventing concurrent modification conflicts.

Examples

use reinhardt_urls::proxy::{CollectionProxy, ScalarValue};

// Requires version tracking to be enabled
// let proxy = CollectionProxy::new("documents", "content")
//     .with_version_tracking(true);
// let mut source = ...;
// let new_value = ScalarValue::String("updated content".to_string());
// proxy.update_with_version(&mut source, new_value, 1).await?;

pub fn with_cache_ttl(self, ttl: u64) -> CollectionProxy

Available on crate feature test only.

Configure cache time-to-live in seconds

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("products", "price")
    .with_caching(true)
    .with_cache_ttl(3600); // 1 hour

pub fn with_chunk_size(self, chunk_size: usize) -> CollectionProxy

Available on crate feature test only.

Configure chunk size for batch operations

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("orders", "total")
    .with_batch_size(100)
    .with_chunk_size(10); // Process 10 items at a time
assert_eq!(proxy.chunk_size(), Some(10));

pub fn with_concurrent_access(self, concurrent: bool) -> CollectionProxy

Available on crate feature test only.

Configure concurrent access settings

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("sessions", "data")
    .with_concurrent_access(true);

pub fn with_fallback_database(self, database: &str) -> CollectionProxy

Available on crate feature test only.

Configure fallback database for read operations

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("users", "name")
    .with_database("primary")
    .with_fallback_database("replica");

pub fn with_procedure_params(self, params: &[(&str, &str)]) -> CollectionProxy

Available on crate feature test only.

Configure parameters for stored procedures

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("reports", "data")
    .with_stored_procedure("generate_report")
    .with_procedure_params(&[("start_date", "2024-01-01"), ("end_date", "2024-12-31")]);

pub fn with_trigger_events(self, events: &[&str]) -> CollectionProxy

Available on crate feature test only.

Configure trigger events to monitor

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("audit_logs", "action")
    .with_triggers(true)
    .with_trigger_events(&["INSERT", "UPDATE", "DELETE"]);

pub fn is_cached(&self) -> bool

Available on crate feature test only.

Check if caching is enabled

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_caching(true);
assert!(proxy.is_cached());

pub fn cache_ttl(&self) -> Option<u64>

Available on crate feature test only.

Get cache time-to-live

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_cache_ttl(300);
assert_eq!(proxy.cache_ttl(), Some(300));

pub fn has_triggers(&self) -> bool

Available on crate feature test only.

Check if triggers are enabled

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("users", "name")
    .with_triggers(true);
assert!(proxy.has_triggers());

pub fn trigger_events(&self) -> &[String]

Available on crate feature test only.

Get trigger events

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("logs", "action")
    .with_trigger_events(&["INSERT", "UPDATE"]);
assert_eq!(proxy.trigger_events().len(), 2);

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

Available on crate feature test only.

Get stored procedure name

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("reports", "data")
    .with_stored_procedure("generate_report");
assert_eq!(proxy.stored_procedure(), Some("generate_report"));

pub fn procedure_params(&self) -> &[(String, String)]

Available on crate feature test only.

Get stored procedure parameters

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("reports", "data")
    .with_procedure_params(&[("year", "2024")]);
assert_eq!(proxy.procedure_params().len(), 1);

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

Available on crate feature test only.

Get target database name

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("users", "name")
    .with_database("primary");
assert_eq!(proxy.database(), Some("primary"));

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

Available on crate feature test only.

Get fallback database name

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("users", "name")
    .with_fallback_database("replica");
assert_eq!(proxy.fallback_database(), Some("replica"));

pub fn is_async_loading(&self) -> bool

Available on crate feature test only.

Check if async loading is enabled

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_async_loading(true);
assert!(proxy.is_async_loading());

pub fn supports_concurrent_access(&self) -> bool

Available on crate feature test only.

Check if concurrent access is supported

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("sessions", "data")
    .with_concurrent_access(true);
assert!(proxy.supports_concurrent_access());

pub fn batch_size(&self) -> Option<usize>

Available on crate feature test only.

Get batch size

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("orders", "total")
    .with_batch_size(100);
assert_eq!(proxy.batch_size(), Some(100));

pub fn chunk_size(&self) -> Option<usize>

Available on crate feature test only.

Get chunk size

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("orders", "total")
    .with_chunk_size(10);
assert_eq!(proxy.chunk_size(), Some(10));

pub fn is_cascade(&self) -> bool

Available on crate feature test only.

Check if cascade is enabled

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("posts", "title")
    .with_cascade(true);
assert!(proxy.is_cascade());

pub fn is_version_tracking(&self) -> bool

Available on crate feature test only.

Check if version tracking is enabled

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("documents", "content")
    .with_version_tracking(true);
assert!(proxy.is_version_tracking());

pub fn memory_limit(&self) -> Option<usize>

Available on crate feature test only.

Get memory limit

Examples

use reinhardt_urls::proxy::CollectionProxy;

let proxy = CollectionProxy::new("large_data", "content")
    .with_memory_limit(1024 * 1024);
assert_eq!(proxy.memory_limit(), Some(1024 * 1024));

Trait Implementations

impl Clone for CollectionProxy

fn clone(&self) -> CollectionProxy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionProxy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollectionProxy

fn deserialize<D>( deserializer: D, ) -> Result<CollectionProxy, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CollectionProxy

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.