Struct async_graphql::http::GraphiQLSource

pub struct GraphiQLSource<'a> { /* private fields */ }

A builder for constructing a GraphiQL (v2) HTML page.

Example

use async_graphql::http::*;

GraphiQLSource::build()
    .endpoint("/")
    .subscription_endpoint("/ws")
    .header("Authorization", "Bearer [token]")
    .credentials(Credentials::Include)
    .finish();

Implementations

impl<'a> GraphiQLSource<'a>

pub fn build() -> GraphiQLSource<'a>

Creates a builder for constructing a GraphiQL (v2) HTML page.

pub fn endpoint(self, endpoint: &'a str) -> GraphiQLSource<'a>

Sets the endpoint of the server GraphiQL will connect to.

pub fn subscription_endpoint(self, endpoint: &'a str) -> GraphiQLSource<'a>

Sets the subscription endpoint of the server GraphiQL will connect to.

pub fn header(self, name: &'a str, value: &'a str) -> GraphiQLSource<'a>

Sets a header to be sent with requests GraphiQL will send.

pub fn title(self, title: &'a str) -> GraphiQLSource<'a>

Sets the html document title.

pub fn credentials(self, credentials: Credentials) -> GraphiQLSource<'a>

Sets credentials option for the fetch requests.

pub fn plugins(self, plugins: &'a [GraphiQLPlugin<'_>]) -> GraphiQLSource<'a>

Sets plugins

pub fn finish(self) -> String

Returns a GraphiQL (v2) HTML page.

Trait Implementations

impl<'a> Default for GraphiQLSource<'a>

fn default() -> GraphiQLSource<'a>

Returns the “default value” for a type.

impl<'a> Serialize for GraphiQLSource<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.