pub struct GraphQlService { /* private fields */ }Expand description
ScrapingService adapter for GraphQL APIs.
Implement any spec-compliant GraphQL endpoint by constructing a
GraphQlService with a config and an optional plugin registry. Target
specifics (endpoint, version headers, auth) are supplied either via
ServiceInput.params directly or through a registered
GraphQlTargetPlugin.
§Example
use stygian_graph::adapters::graphql::{GraphQlService, GraphQlConfig};
use stygian_graph::ports::{ScrapingService, ServiceInput};
use serde_json::json;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let service = GraphQlService::new(GraphQlConfig::default(), None);
let input = ServiceInput {
url: "https://countries.trevorblades.com/".to_string(),
params: json!({
"query": "{ countries { code name } }"
}),
};
let output = service.execute(input).await?;
println!("{}", output.data);
Ok(())
}Implementations§
Source§impl GraphQlService
impl GraphQlService
Sourcepub fn new(
config: GraphQlConfig,
plugins: Option<Arc<GraphQlPluginRegistry>>,
) -> Self
pub fn new( config: GraphQlConfig, plugins: Option<Arc<GraphQlPluginRegistry>>, ) -> Self
Create a new GraphQlService.
plugins may be None for raw-params mode (no plugin resolution).
§Example
use stygian_graph::adapters::graphql::{GraphQlService, GraphQlConfig};
use stygian_graph::ports::ScrapingService;
let service = GraphQlService::new(GraphQlConfig::default(), None);
assert_eq!(service.name(), "graphql");Sourcepub fn with_auth_port(self, port: Arc<dyn ErasedAuthPort>) -> Self
pub fn with_auth_port(self, port: Arc<dyn ErasedAuthPort>) -> Self
Attach a runtime auth port.
When set, the port’s erased_resolve_token() will be called to obtain
a bearer token whenever params.auth is absent and the plugin supplies
no default_auth.
§Example
use std::sync::Arc;
use stygian_graph::adapters::graphql::{GraphQlService, GraphQlConfig};
use stygian_graph::ports::auth::{EnvAuthPort, ErasedAuthPort};
let auth: Arc<dyn ErasedAuthPort> = Arc::new(EnvAuthPort::new("API_TOKEN"));
let service = GraphQlService::new(GraphQlConfig::default(), None)
.with_auth_port(auth);Trait Implementations§
Source§impl ScrapingService for GraphQlService
impl ScrapingService for GraphQlService
Source§fn execute<'life0, 'async_trait>(
&'life0 self,
input: ServiceInput,
) -> Pin<Box<dyn Future<Output = Result<ServiceOutput>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn execute<'life0, 'async_trait>(
&'life0 self,
input: ServiceInput,
) -> Pin<Box<dyn Future<Output = Result<ServiceOutput>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Execute a GraphQL query.
Reads ServiceInput.params for:
query(required) — the GraphQL query stringvariables— optional JSON objectoperation_name— optional stringauth— optional{"kind": "bearer"|"api_key"|"header"|"none", "token": "..."}headers— optional extra headers objectplugin— optional plugin name to resolve from the registrypagination— optional{"strategy": "cursor", "page_info_path": "...", "edges_path": "...", "page_size": 50}
§Errors
Returns Err for HTTP ≥ 400, invalid JSON, GraphQL errors[], missing
data key, throttle detection, or pagination runaway.
Auto Trait Implementations§
impl Freeze for GraphQlService
impl !RefUnwindSafe for GraphQlService
impl Send for GraphQlService
impl Sync for GraphQlService
impl Unpin for GraphQlService
impl !UnwindSafe for GraphQlService
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);