Struct ProtocolError 

pub struct ProtocolError { /* private fields */ }

A safe, localizable protocol error payload.

Implementations

impl ProtocolError

pub fn new( code: AgentErrorCode, message: impl Into<String>, retry: RetryClass, ) -> Result<Self, ProtocolErrorValidationError>

Creates a validated protocol error without serializing an internal source chain.

Errors

Returns an error when the technical message is empty, contains a null character, or exceeds MAX_ERROR_MESSAGE_BYTES.

pub fn unsupported_command(correlation_id: CorrelationId) -> Self

Creates the canonical unsupported-command error for protocol 1.x.

pub fn with_correlation_id(self, correlation_id: CorrelationId) -> Self

Adds a diagnostic correlation identifier.

pub fn with_details(self, details: ProtocolMetadata) -> Self

Adds validated, bounded safe details.

pub const fn code(&self) -> AgentErrorCode

Returns the stable error code.

pub fn message(&self) -> &str

Returns the English technical diagnostic message.

pub const fn retry(&self) -> RetryClass

Returns the retry classification.

pub const fn correlation_id(&self) -> Option<&CorrelationId>

Returns the optional diagnostic correlation identifier.

pub const fn details(&self) -> &ProtocolMetadata

Returns bounded safe structured details.

Trait Implementations

impl Clone for ProtocolError

fn clone(&self) -> ProtocolError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolError

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProtocolError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProtocolError

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 ProtocolError