Skip to main content

EmbeddingCompatibilityDescriptor

Struct EmbeddingCompatibilityDescriptor 

Source
pub struct EmbeddingCompatibilityDescriptor { /* private fields */ }
Expand description

Validated compatibility descriptor whose canonical JSON is identity input.

Implementations§

Source§

impl EmbeddingCompatibilityDescriptor

Source

pub fn new( input: EmbeddingCompatibilityInput, ) -> Result<Self, SearchArtifactError>

Validate all compatibility fields and freeze schema version 1.

§Errors

Rejects incomplete producer/tokenizer/chunking identities, empty recipes, unnormalized strings, excessive nesting, and oversized canonical JSON.

Source

pub fn from_json(path: &Path, bytes: &[u8]) -> Result<Self, SearchArtifactError>

Parse one exact canonical persisted descriptor and re-run validation.

§Errors

Distinguishes oversized, malformed/corrupt, and incompatible descriptor bytes. Unknown fields and noncanonical encodings fail closed.

Source

pub fn to_canonical_json(&self) -> Result<Vec<u8>, SearchArtifactError>

Serialize compact JSON with every object key sorted by UTF-8 bytes.

§Errors

Returns a structured validation error if serialization exceeds the v1 bound.

Source

pub fn compatibility_id( &self, ) -> Result<EmbeddingCompatibilityId, SearchArtifactError>

SHA-256 compatibility identity over canonical descriptor JSON.

§Errors

Propagates canonical serialization validation.

Source

pub const fn dimensions(&self) -> u32

Fixed vector width.

Source

pub const fn normalization(&self) -> EmbeddingNormalization

Persisted vector normalization contract.

Source

pub const fn producer(&self) -> &EmbeddingProducerIdentity

Statically distinct producer descriptor.

Source

pub const fn tokenizer(&self) -> Option<&TokenizerIdentity>

Persisted tokenizer identity for text-derived embeddings.

Source

pub const fn chunking(&self) -> Option<&ChunkingIdentity>

Persisted explicit chunking contract, if any.

Trait Implementations§

Source§

impl Clone for EmbeddingCompatibilityDescriptor

Source§

fn clone(&self) -> EmbeddingCompatibilityDescriptor

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 EmbeddingCompatibilityDescriptor

Source§

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

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

impl PartialEq for EmbeddingCompatibilityDescriptor

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for EmbeddingCompatibilityDescriptor

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 StructuralPartialEq for EmbeddingCompatibilityDescriptor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V