Enum ProtocolError 

#[non_exhaustive]
pub enum ProtocolError {
    ColimitFailed(GatError),
    LimitExceeded(LimitExceeded),
    TheoryRegistration {
        stage: String,
        source: Box<GatError>,
    },
    SchemaBuild(SchemaError),
    Json(Error),
    Parse(String),
    MissingField(String),
    UnknownRef(String),
    Emit(String),
    ProtocolMismatch {
        expected: String,
        actual: String,
    },
}

Errors from protocol parsing or definition.

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.

ColimitFailed(GatError)

A theory colimit failed during protocol construction.

LimitExceeded(LimitExceeded)

A bounded resource ran out while reading or building a schema.

Names which allowance was exhausted and what it was set to, so raising it is a matter of reading the error rather than guessing which of several unrelated bounds was reached.

TheoryRegistration

Composing a protocol’s theories failed, so the registry entry it would have produced could not be built.

Distinct from ProtocolError::ColimitFailed in naming the composition stage: a protocol’s theory set is built by several pushouts in sequence, and which one failed is what identifies the theory that is missing.

Fields

stage: String

The composition stage that failed.

source: Box<GatError>

The failure that stage reported.

Boxed so this variant does not enlarge ProtocolError. ColimitFailed already holds a GatError inline, so carrying one plus a String here would make this the largest variant and push every Result wrapping a ProtocolError over clippy’s result_large_err threshold, several crates downstream.

SchemaBuild(SchemaError)

A schema building step failed.

Json(Error)

JSON parsing failed.

Parse(String)

The input format was invalid or unsupported.

MissingField(String)

A required field is missing in the input.

UnknownRef(String)

The input references an unknown type or definition.

Emit(String)

Emit/serialization failed.

ProtocolMismatch

The schema does not match the expected protocol structure.

Fields

expected: String

Expected protocol name.

actual: String

Actual vertex kinds found.

Trait Implementations

impl Debug for ProtocolError

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

Formats the value using the given formatter.

impl Display for ProtocolError

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

Formats the value using the given formatter.

impl Error for ProtocolError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for ProtocolError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<GatError> for ProtocolError

fn from(source: GatError) -> Self

Converts to this type from the input type.

impl From<LimitExceeded> for ProtocolError

fn from(source: LimitExceeded) -> Self

Converts to this type from the input type.

impl From<SchemaError> for ProtocolError

fn from(source: SchemaError) -> Self

Converts to this type from the input type.