Struct GraphiQLSource 

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

Available on crate feature graphiql only.

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

Example

use async_graphql::http::*;

GraphiQLSource::build()
    .endpoint("/")
    .subscription_endpoint("/ws")
    .header("Authorization", "Bearer [token]")
    .ws_connection_param("token", "[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 version(self, value: &'a str) -> GraphiQLSource<'a>

Sets the version of GraphiQL to be fetched.

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

Sets a WS connection param to be sent during GraphiQL WS connections.

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 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> Display for GraphiQLSource<'a>

Implement the format!() trait for GraphiQLSource

Please be aware of the rendering performance notice in the Template trait.

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

Formats the value using the given formatter.

impl<'a> FastWritable for GraphiQLSource<'a>

fn write_into<AskamaW>( &self, dest: &mut AskamaW, values: &dyn Values, ) -> Result<()>

where AskamaW: Write + ?Sized,

Used internally by askama to speed up writing some types.

impl<'a> Template for GraphiQLSource<'a>

const SIZE_HINT: usize = 3315usize

Provides a rough estimate of the expanded length of the rendered template. Larger values result in higher memory usage but fewer reallocations. Smaller values result in the opposite. This value only affects render. It does not take effect when calling render_into, write_into, the fmt::Display implementation, or the blanket ToString::to_string implementation.

fn render_into_with_values<AskamaW>( &self, __askama_writer: &mut AskamaW, __askama_values: &dyn Values, ) -> Result<()>

where AskamaW: Write + ?Sized,

Renders the template to the given writer fmt buffer with provided Values.

fn render(&self) -> Result<String, Error>

Available on crate feature alloc only.

Helper method which allocates a new String and renders into it.

fn render_with_values(&self, values: &dyn Values) -> Result<String, Error>

Available on crate feature alloc only.

Helper method which allocates a new String and renders into it with provided Values.

fn render_into<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

Renders the template to the given writer fmt buffer.

fn write_into<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

Available on crate feature std only.

Renders the template to the given writer io buffer.

fn write_into_with_values<W>( &self, writer: &mut W, values: &dyn Values, ) -> Result<(), Error>

where W: Write + ?Sized,

Available on crate feature std only.

Renders the template to the given writer io buffer with provided Values.