Enum RelatedReadScope 

pub enum RelatedReadScope {
    Policy {
        allow: &'static [ReadPolicy],
        deny: &'static [ReadPolicy],
        soft_delete_column: Option<&'static str>,
    },
    Unscoped,
}

Variants

Policy

Apply the related model’s list-slot read policy (@@allow/@@deny on read/list) and its @@soft_delete filter inside the subquery — exactly what find_many on that model applies, which is also what ?include= goes through. A related row the caller cannot read then behaves as if it did not exist: a to-one filter (including ne and isNull) does not match it, none/every over hidden-only children are vacuously true, and a relation sort key reads as NULL.

An empty allow slice renders FALSE (default deny), the same as a direct read of a model with no read rule.

Fields

allow: &'static [ReadPolicy]

deny: &'static [ReadPolicy]

soft_delete_column: Option<&'static str>

Some("deleted_at") when the related model is @@soft_delete.

Unscoped

Escape hatch: read the related table raw — no policy, no soft-delete filter. For trusted server code that deliberately wants every related row regardless of the caller. The embedded (rusqlite) backend ignores the scope either way. Generated client code (which never renders SQL) also uses it. Never use it for a filter or sort whose values a caller controls.

Trait Implementations

impl Clone for RelatedReadScope

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RelatedReadScope

impl Debug for RelatedReadScope

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

Formats the value using the given formatter.

impl Eq for RelatedReadScope

impl PartialEq for RelatedReadScope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RelatedReadScope