Enum BodyTransform 

pub enum BodyTransform {
    None,
    Inject(Vec<InjectedField>),
    ConstructId(DocIdRule),
    Both {
        inject: Vec<InjectedField>,
        id: DocIdRule,
    },
}

How the request body must be transformed before it is forwarded.

For single-doc ingest the transform injects tenancy fields and/or constructs the document _id. osproxy-rewrite performs the transform; this enum is the instruction. Not #[non_exhaustive]: the engine must apply every transform kind, so a new kind should force the plan builder to be updated.

Examples

use osproxy_spi::BodyTransform;
assert!(BodyTransform::None.is_none());
assert!(!BodyTransform::Inject(vec![]).is_none());

Variants

None

Forward the body unchanged.

Inject(Vec<InjectedField>)

Inject named fields into the document.

ConstructId(DocIdRule)

Construct the _id (and optionally _routing) from a rule.

Both

Both inject fields and construct the id.

Fields

inject: Vec<InjectedField>

Fields to inject.

id: DocIdRule

Id-construction rule.

Implementations

impl BodyTransform

pub fn is_none(&self) -> bool

Whether this transform leaves the body untouched.

Trait Implementations

impl Clone for BodyTransform

fn clone(&self) -> BodyTransform

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BodyTransform

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

Formats the value using the given formatter.

impl Eq for BodyTransform

impl PartialEq for BodyTransform

fn eq(&self, other: &BodyTransform) -> 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 StructuralPartialEq for BodyTransform