Enum CanonicalPayload 

#[non_exhaustive]
pub enum CanonicalPayload {
    Text(String),
    Binary(Vec<u8>),
}

Normalized payload ready for downstream stages.

CanonicalPayload represents the final, processed form of ingest payload. Text payloads have whitespace normalized, while binary payloads pass through unchanged.

Variants

• Text(String): Normalized UTF-8 text with collapsed whitespace
• Binary(Vec<u8>): Binary payload preserved exactly

Examples

use ingest::CanonicalPayload;

// Normalized text
let text = CanonicalPayload::Text("Hello world".to_string());

// Preserved binary
let binary = CanonicalPayload::Binary(vec![0x89, 0x50, 0x4E, 0x47]);

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.

Text(String)

Normalized UTF-8 text payload.

Text has been through whitespace normalization (multiple spaces/tabs/newlines collapsed to single spaces, leading/trailing whitespace trimmed).

Example

use ingest::CanonicalPayload;

// This represents text that was "  Hello   world  " before normalization
let payload = CanonicalPayload::Text("Hello world".to_string());

Binary(Vec<u8>)

Binary payload preserved for downstream perceptual/semantic stages.

Binary data (images, PDFs, audio, etc.) passes through ingest unchanged except for the non-empty validation.

Example

use ingest::CanonicalPayload;

let payload = CanonicalPayload::Binary(vec![0x89, 0x50, 0x4E, 0x47]);

Implementations

impl CanonicalPayload

pub fn len(&self) -> usize

Returns the length of the payload in bytes.

Example

use ingest::CanonicalPayload;

let text = CanonicalPayload::Text("Hello".to_string());
assert_eq!(text.len(), 5);

let binary = CanonicalPayload::Binary(vec![1, 2, 3, 4]);
assert_eq!(binary.len(), 4);

pub fn is_empty(&self) -> bool

Returns true if the payload is empty.

Note: Empty payloads should never reach this stage (they are rejected during ingest), but this method is provided for completeness.

pub fn is_text(&self) -> bool

Returns true if this is a text payload.

pub fn is_binary(&self) -> bool

Returns true if this is a binary payload.

Trait Implementations

impl Clone for CanonicalPayload

fn clone(&self) -> CanonicalPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CanonicalPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CanonicalPayload

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CanonicalPayload

impl StructuralPartialEq for CanonicalPayload