Struct InterfaceDescriptor 

pub struct InterfaceDescriptor {
    pub format: String,
    pub documentation: Option<Documentation>,
    pub types: Vec<TypeDeclaration>,
    pub operations: Vec<OperationDeclaration>,
}

Transport-independent description of one interface.

Interface identity is supplied by interaction fields such as FetchInterfaceResponse::interface, not embedded in the descriptor.

Fields

format: String

Descriptor format version understood by clients and hosts.

documentation: Option<Documentation>

Optional interface documentation.

types: Vec<TypeDeclaration>

Named declarations local to this descriptor.

operations: Vec<OperationDeclaration>

Operations exposed by this interface.

Implementations

impl InterfaceDescriptor

pub fn validate(&self) -> Result<(), ValidationError>

Validates declaration structure, named references, and absence of cycles.

pub fn validate_value( &self, type: &TypeExpr, value: &Value, ) -> Result<(), ValidationError>

Validates a raw value against a type expression in this descriptor.

pub fn validate_arguments( &self, operation: &str, arguments: &BTreeMap<String, Value>, ) -> Result<(), ValidationError>

Validates named arguments for one declared operation.

pub fn validate_result( &self, operation: &str, result: &Value, ) -> Result<(), ValidationError>

Validates one operation result against its return declaration.

pub fn validate_call( &self, request: &CallOperationRequest, ) -> Result<(), ValidationError>

Validates the path, operation, and arguments in a call request.

Trait Implementations

impl Clone for InterfaceDescriptor

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 InterfaceDescriptor

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

Formats the value using the given formatter.

impl Eq for InterfaceDescriptor

impl PartialEq for InterfaceDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InterfaceDescriptor