Struct DirectiveDefinition 

pub struct DirectiveDefinition {
    pub name: String,
    pub description: Option<String>,
    pub locations: Vec<DirectiveLocationKind>,
    pub arguments: Vec<ArgumentDefinition>,
    pub is_repeatable: bool,
}

A custom directive definition for schema extension.

Allows defining custom directives beyond the built-in @skip, @include, and @deprecated directives. Custom directives are exposed via introspection and can be evaluated at runtime via registered handlers.

Example

use fraiseql_core::schema::{DirectiveDefinition, DirectiveLocationKind, ArgumentDefinition, FieldType};

let rate_limit = DirectiveDefinition {
    name: "rateLimit".to_string(),
    description: Some("Apply rate limiting to this field".to_string()),
    locations: vec![DirectiveLocationKind::FieldDefinition],
    arguments: vec![
        ArgumentDefinition::new("limit", FieldType::Int),
        ArgumentDefinition::optional("window", FieldType::String),
    ],
    is_repeatable: false,
};

Fields

name: String

Directive name (e.g., “rateLimit”, “auth”).

description: Option<String>

Description of what this directive does.

locations: Vec<DirectiveLocationKind>

Valid locations where this directive can be applied.

arguments: Vec<ArgumentDefinition>

Arguments this directive accepts.

is_repeatable: bool

Whether this directive can be applied multiple times to the same location.

Implementations

impl DirectiveDefinition

pub fn new( name: impl Into<String>, locations: Vec<DirectiveLocationKind>, ) -> Self

Create a new directive definition.

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

Set the description.

pub fn with_argument(self, arg: ArgumentDefinition) -> Self

Add an argument to this directive.

pub fn with_arguments(self, args: Vec<ArgumentDefinition>) -> Self

Add multiple arguments to this directive.

pub fn repeatable(self) -> Self

Mark this directive as repeatable.

pub fn valid_at(&self, location: DirectiveLocationKind) -> bool

Check if this directive can be applied at the given location.

pub fn find_argument(&self, name: &str) -> Option<&ArgumentDefinition>

Find an argument by name.

Trait Implementations

impl Clone for DirectiveDefinition

fn clone(&self) -> DirectiveDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DirectiveDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DirectiveDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DirectiveDefinition

fn eq(&self, other: &DirectiveDefinition) -> 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 DirectiveDefinition

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 DirectiveDefinition