Skip to main content

RawIngestRecord

Struct RawIngestRecord 

Source
pub struct RawIngestRecord {
    pub id: String,
    pub source: IngestSource,
    pub metadata: IngestMetadata,
    pub payload: Option<IngestPayload>,
}
Expand description

The inbound record for ingest.

RawIngestRecord is the primary input type for the ingest pipeline. It contains all information needed to process content: identification, source metadata, and optional payload.

§Lifecycle

  1. Create RawIngestRecord with raw data
  2. Call ingest() to normalize
  3. Receive CanonicalIngestRecord for downstream processing

§Examples

§Text Content

use ingest::{RawIngestRecord, IngestMetadata, IngestSource, IngestPayload};
use chrono::Utc;

let record = RawIngestRecord {
    id: "text-001".to_string(),
    source: IngestSource::RawText,
    metadata: IngestMetadata {
        tenant_id: Some("tenant".to_string()),
        doc_id: Some("doc".to_string()),
        received_at: Some(Utc::now()),
        original_source: None,
        attributes: None,
    },
    payload: Some(IngestPayload::Text(
        "  Content with   extra spaces  ".to_string()
    )),
};

§Binary File

use ingest::{RawIngestRecord, IngestMetadata, IngestSource, IngestPayload};

let record = RawIngestRecord {
    id: "file-001".to_string(),
    source: IngestSource::File {
        filename: "image.png".to_string(),
        content_type: Some("image/png".to_string()),
    },
    metadata: IngestMetadata {
        tenant_id: Some("tenant".to_string()),
        doc_id: Some("doc-123".to_string()),
        received_at: None,
        original_source: Some("uploads/image.png".to_string()),
        attributes: None,
    },
    payload: Some(IngestPayload::Binary(vec![0x89, 0x50, 0x4E, 0x47])),
};

Fields§

§id: String

Unique identifier for this ingest operation.

This ID is used for:

  • Tracing and log correlation
  • Deterministic document ID derivation (when doc_id not provided)
  • Deduplication and idempotency

Should be unique per ingest request. If not provided, a UUID should be generated by the caller.

§Example

use ingest::RawIngestRecord;

let record = RawIngestRecord {
    id: "ingest-550e8400-e29b-41d4-a716-446655440000".to_string(),
    ..Default::default()
};
§source: IngestSource

Source of the content.

Indicates where the content came from and affects validation rules. See IngestSource for details.

§metadata: IngestMetadata

Metadata associated with the record.

Contains contextual information like tenant, timestamps, and custom attributes. See IngestMetadata for details.

§payload: Option<IngestPayload>

Raw payload content.

The actual content being ingested. May be None for metadata-only events (e.g., IngestSource::Api).

See IngestPayload for the different payload types.

Trait Implementations§

Source§

impl Clone for RawIngestRecord

Source§

fn clone(&self) -> RawIngestRecord

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RawIngestRecord

Source§

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

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

impl Default for RawIngestRecord

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for RawIngestRecord

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for RawIngestRecord

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Serialize for RawIngestRecord

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for RawIngestRecord

Source§

impl StructuralPartialEq for RawIngestRecord

Auto Trait Implementations§

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<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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,