Struct InterfaceDefinition 

pub struct InterfaceDefinition {
    pub name: String,
    pub fields: Vec<FieldDefinition>,
    pub description: Option<String>,
}

A GraphQL interface type definition.

Interfaces define a common set of fields that multiple types can implement. They enable polymorphic queries where a field can return any type that implements the interface.

Example

use fraiseql_core::schema::{InterfaceDefinition, FieldDefinition, FieldType};

let node_interface = InterfaceDefinition {
    name: "Node".to_string(),
    fields: vec![
        FieldDefinition::new("id", FieldType::Id),
    ],
    description: Some("An object with an ID".to_string()),
};

Fields

name: String

Interface name (e.g., “Node”).

fields: Vec<FieldDefinition>

Fields that implementing types must define.

description: Option<String>

Description of the interface.

Implementations

impl InterfaceDefinition

pub fn new(name: impl Into<String>) -> Self

Create a new interface definition.

pub fn with_field(self, field: FieldDefinition) -> Self

Add a field to this interface.

pub fn with_fields(self, fields: Vec<FieldDefinition>) -> Self

Add multiple fields to this interface.

pub fn with_description(self, description: impl Into<String>) -> Self

Set description.

pub fn find_field(&self, name: &str) -> Option<&FieldDefinition>

Find a field by name.

Trait Implementations

impl Clone for InterfaceDefinition

fn clone(&self) -> InterfaceDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InterfaceDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InterfaceDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InterfaceDefinition

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InterfaceDefinition

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 InterfaceDefinition