Struct Opaque 

#[non_exhaustive]
pub struct Opaque {
    pub reasons: Vec<OpaqueReason>,
    pub note: Option<String>,
}

The record a waiver leaves on one operation.

Serialized under OPAQUE_OPERATION_ANNOTATION. Marks the operation unverified; never removes it.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

reasons: Vec<OpaqueReason>

Every reason recorded, in the order they were recorded, deduplicated.

note: Option<String>

Where the waiver was taken, for a human reading the description.

Implementations

impl Opaque

pub fn new(reason: OpaqueReason) -> Self

A marker carrying one reason.

pub fn with_reason(self, reason: OpaqueReason) -> Self

Adds a reason, idempotently.

pub fn with_note(self, note: impl Into<String>) -> Self

Records where the waiver was taken.

pub fn absorb(&mut self, other: &Self)

Unions other’s reasons into this marker, keeping the first note.

pub fn is_annotated(operation: &Operation) -> bool

Whether operation carries the annotation at all.

True even when the value is malformed, so that a description Kynos cannot read is still treated as unverified rather than as clean.

pub fn of(operation: &Operation) -> Result<Option<Self>, MalformedAnnotation>

Reads the marker from an operation.

Ok(None) means the operation carries no marker. A reason this build does not know is not an error — it round-trips as OpaqueReason::Unrecognized — so an error here means the value was hand-written into a shape Kynos never emits.

Errors

Returns MalformedAnnotation when the annotation is present but unreadable.

pub fn apply_to( &self, operation: &mut Operation, ) -> Result<(), MalformedAnnotation>

Writes the marker onto an operation, merging with any already present.

Errors

Returns MalformedAnnotation when the operation already carries an unreadable marker, rather than replacing it. Overwriting would delete a waiver someone recorded, which is the one thing this whole mechanism exists to prevent.

Panics

Panics only if this marker cannot be serialized, which the type makes impossible.

Trait Implementations

impl Clone for Opaque

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Opaque

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

Formats the value using the given formatter.

impl Default for Opaque

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Opaque

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Opaque

impl PartialEq for Opaque

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Opaque

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Opaque