Struct QueryScope 

pub struct QueryScope {
    pub locator: StorageLocator,
    pub filter: Option<FilterExpr>,
    pub projection: Projection,
}

Shared collection and result scope.

The scope is shared by vector and text requests. Construction only builds a request; the selected backend validates fields and supported combinations when executing it.

Examples

use storage_kit::database::StorageLocator;
use storage_kit::database::data::FilterExpr;
use storage_kit::database::query::{Projection, QueryScope};
let scope = QueryScope::new(StorageLocator::new("documents"))
    .filter(FilterExpr::eq("published", true))
    .projection(Projection::Columns(vec!["title".to_owned()]));
assert!(scope.filter.is_some());

Fields

locator: StorageLocator

Logical collection.

filter: Option<FilterExpr>

Optional structured filter.

projection: Projection

Returned fields.

Implementations

impl QueryScope

pub fn new(locator: StorageLocator) -> Self

Creates an unfiltered all-field scope.

Examples

use storage_kit::database::StorageLocator;
use storage_kit::database::query::{Projection, QueryScope};
let scope = QueryScope::new(StorageLocator::new("documents"));
assert_eq!(scope.projection, Projection::All);
assert!(scope.filter.is_none());

pub fn filter(self, filter: FilterExpr) -> Self

Applies a filter.

Examples

use storage_kit::database::StorageLocator;
use storage_kit::database::data::FilterExpr;
use storage_kit::database::query::QueryScope;
let scope = QueryScope::new(StorageLocator::new("documents"))
    .filter(FilterExpr::eq("published", true));
assert!(scope.filter.is_some());

pub fn projection(self, projection: Projection) -> Self

Replaces returned fields.

Examples

use storage_kit::database::StorageLocator;
use storage_kit::database::query::{Projection, QueryScope};
let scope = QueryScope::new(StorageLocator::new("documents"))
    .projection(Projection::Columns(vec!["title".to_owned()]));
assert_eq!(scope.projection, Projection::Columns(vec!["title".to_owned()]));

Trait Implementations

impl Clone for QueryScope

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryScope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryScope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StorageLocator> for QueryScope

fn from(locator: StorageLocator) -> Self

Converts to this type from the input type.

impl PartialEq for QueryScope

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for QueryScope

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 QueryScope