Enum RewriteError 

#[non_exhaustive]
pub enum RewriteError {
    NotAnObject,
    InvalidJson,
    ReservedFieldCollision {
        field: FieldName,
    },
    PathNotScalar {
        path: String,
    },
    UnsupportedPlaceholder {
        placeholder: String,
    },
    MalformedBulkAction,
    IrreversibleIdTemplate,
    Unfilterable {
        construct: &'static str,
    },
}

A failure applying a body transform.

These are document-shape failures (the body is not what the transform requires) or safety failures (a client field would collide with an injected tenancy field). They carry only field names and shapes, never values, so they are safe to surface in telemetry (NFR-S2).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NotAnObject

The body was expected to be a JSON object but was not.

InvalidJson

The body bytes were not valid JSON.

ReservedFieldCollision

A field the transform must inject already exists in the client document. Rejected rather than overwritten: a client could otherwise spoof a tenancy field and defeat isolation (docs/03).

Fields

field: FieldName

The colliding field name.

PathNotScalar

A path referenced by a partition key or id template does not resolve to a scalar value in the document.

Fields

path: String

The dotted path that failed to resolve.

UnsupportedPlaceholder

An id template referenced a placeholder the transform does not support.

Fields

placeholder: String

The placeholder text, without braces.

MalformedBulkAction

A _bulk action line is not a single-key {verb: {…}} object, names an unknown verb, or an action that needs a source line has none.

IrreversibleIdTemplate

An id template cannot be reversed to recover a logical id on the read path: a logical→physical mapping needs exactly one {body.<path>} placeholder (the natural key), so a template with none or several is not usable for GetById/DeleteById (docs/03 §4, docs/04 §5).

Unfilterable

A shared-index search carries a construct that escapes the mandatory partition filter, a global aggregation (which OpenSearch evaluates against the whole index, ignoring the query) or a suggest block (which runs independent of the query). Either would read across partitions, so it is refused: the isolation boundary is filter-or-reject, never best-effort (docs/03 §5, NFR-S4). Carries only the construct name.

Fields

construct: &'static str

The offending construct: "global aggregation" or "suggest".

Trait Implementations

impl Debug for RewriteError

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

Formats the value using the given formatter.

impl Display for RewriteError

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

Formats the value using the given formatter.

impl Eq for RewriteError

impl Error for RewriteError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<JsonError> for RewriteError

Maps a byte-scanner failure onto the transform error vocabulary, so the byte-level inject/id primitives surface the same variants as the Value path.

fn from(err: JsonError) -> Self

Converts to this type from the input type.

impl PartialEq for RewriteError

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