Struct GenericGraphQlPluginBuilder 

pub struct GenericGraphQlPluginBuilder { /* private fields */ }

Builder for GenericGraphQlPlugin.

Obtain via GenericGraphQlPlugin::builder(). The only required fields are name and endpoint; everything else has sensible defaults.

Implementations

impl GenericGraphQlPluginBuilder

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

Set the plugin name (required).

Example

use stygian_graph::adapters::graphql_plugins::generic::GenericGraphQlPlugin;

let _builder = GenericGraphQlPlugin::builder().name("my-api");

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

Set the GraphQL endpoint URL (required).

Example

use stygian_graph::adapters::graphql_plugins::generic::GenericGraphQlPlugin;

let _builder = GenericGraphQlPlugin::builder()
    .endpoint("https://api.example.com/graphql");

pub fn header(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a single request header.

May be called multiple times to accumulate headers.

Example

use stygian_graph::adapters::graphql_plugins::generic::GenericGraphQlPlugin;

let _builder = GenericGraphQlPlugin::builder()
    .header("X-Api-Version", "2025-01-01")
    .header("Accept-Language", "en");

pub fn headers(self, headers: HashMap<String, String>) -> Self

Replace all headers with a pre-built map.

Example

use std::collections::HashMap;
use stygian_graph::adapters::graphql_plugins::generic::GenericGraphQlPlugin;

let headers: HashMap<_, _> = [("X-Version", "1")].into_iter()
    .map(|(k, v)| (k.to_string(), v.to_string()))
    .collect();
let _builder = GenericGraphQlPlugin::builder().headers(headers);

pub fn auth(self, auth: GraphQlAuth) -> Self

Set the default auth credentials.

Example

use stygian_graph::adapters::graphql_plugins::generic::GenericGraphQlPlugin;
use stygian_graph::ports::{GraphQlAuth, GraphQlAuthKind};

let _builder = GenericGraphQlPlugin::builder()
    .auth(GraphQlAuth {
        kind: GraphQlAuthKind::Bearer,
        token: "${env:GITHUB_TOKEN}".to_string(),
        header_name: None,
    });

pub fn bearer_auth(self, token: impl Into<String>) -> Self

Convenience helper: set a Bearer-token auth from a string.

Example

use stygian_graph::adapters::graphql_plugins::generic::GenericGraphQlPlugin;

let _builder = GenericGraphQlPlugin::builder()
    .bearer_auth("${env:MY_TOKEN}");

pub const fn cost_throttle(self, throttle: CostThrottleConfig) -> Self

Attach a cost-throttle configuration for proactive pre-flight delays.

Example

use stygian_graph::adapters::graphql_plugins::generic::GenericGraphQlPlugin;
use stygian_graph::adapters::graphql_throttle::CostThrottleConfig;

let _builder = GenericGraphQlPlugin::builder()
    .cost_throttle(CostThrottleConfig::default());

pub const fn page_size(self, page_size: usize) -> Self

Override the default page size (default: 50).

Example

use stygian_graph::adapters::graphql_plugins::generic::GenericGraphQlPlugin;

let _builder = GenericGraphQlPlugin::builder().page_size(30);

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

Set a human-readable description of the plugin.

Example

use stygian_graph::adapters::graphql_plugins::generic::GenericGraphQlPlugin;

let _builder = GenericGraphQlPlugin::builder()
    .description("GitHub public API v4");

pub fn build(self) -> Result<GenericGraphQlPlugin, BuildError>

Consume the builder and produce a GenericGraphQlPlugin.

Returns Err if name or endpoint were not set.

Example

use stygian_graph::adapters::graphql_plugins::generic::GenericGraphQlPlugin;
use stygian_graph::ports::graphql_plugin::GraphQlTargetPlugin;

let plugin = GenericGraphQlPlugin::builder()
    .name("github")
    .endpoint("https://api.github.com/graphql")
    .build()
    .expect("ok");

assert_eq!(plugin.name(), "github");

Trait Implementations

impl Debug for GenericGraphQlPluginBuilder

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

Formats the value using the given formatter.

impl Default for GenericGraphQlPluginBuilder

fn default() -> GenericGraphQlPluginBuilder

Returns the “default value” for a type.