Skip to main content

DocOp

Enum DocOp 

Source
pub enum DocOp {
    Index {
        id: Option<String>,
        routing: Option<String>,
        body: Vec<u8>,
    },
    Create {
        id: Option<String>,
        routing: Option<String>,
        body: Vec<u8>,
    },
    Update {
        id: String,
        routing: Option<String>,
        body: Vec<u8>,
    },
    Delete {
        id: String,
        routing: Option<String>,
    },
}
Expand description

A document-level operation: the already-transformed body plus the constructed id/routing (the tenancy rewrite has already run, docs/04).

Not #[non_exhaustive]: every sink must handle every op kind, so adding one should force sinks to be updated.

Variants§

§

Index

Index (create-or-replace) a document.

Fields

§id: Option<String>

The constructed document id, or None to let OpenSearch auto-assign.

§routing: Option<String>

The _routing value (the partition id), if routing is enabled.

§body: Vec<u8>

The transformed document body (injected fields applied).

§

Create

Create a document, failing with a conflict if the id already exists (op_type=create). Distinct from DocOp::Index so the sink can target the _create endpoint and surface the 409 (docs/04 §3).

Fields

§id: Option<String>

The constructed document id, or None to let OpenSearch auto-assign.

§routing: Option<String>

The _routing value (the partition id), if routing is enabled.

§body: Vec<u8>

The transformed document body (injected fields applied).

§

Update

Partial-update a document by id (_update): the body carries the already-transformed doc/upsert/script (docs/04 §3).

Fields

§id: String

The constructed document id to update.

§routing: Option<String>

The _routing value, if routing is enabled.

§body: Vec<u8>

The transformed update body (injected into doc/upsert).

§

Delete

Delete a document by id.

Fields

§id: String

The constructed document id to delete.

§routing: Option<String>

The _routing value, if routing is enabled.

Trait Implementations§

Source§

impl Clone for DocOp

Source§

fn clone(&self) -> DocOp

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DocOp

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DocOp

Source§

impl PartialEq for DocOp

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for DocOp

Auto Trait Implementations§

§

impl Freeze for DocOp

§

impl RefUnwindSafe for DocOp

§

impl Send for DocOp

§

impl Sync for DocOp

§

impl Unpin for DocOp

§

impl UnsafeUnpin for DocOp

§

impl UnwindSafe for DocOp

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more