Struct diana::OptionsBuilder

pub struct OptionsBuilder<C, Q, M, S> where
    C: Any + Send + Sync + Clone,
    Q: Clone + ObjectType + 'static,
    M: Clone + ObjectType + 'static,
    S: Clone + SubscriptionType + 'static,  { /* fields omitted */ }

A builder-style struct to create an instance of Options idiomatically.

Implementations

impl<C, Q, M, S> OptionsBuilder<C, Q, M, S> where
    C: Any + Send + Sync + Clone,
    Q: Clone + ObjectType + 'static,
    M: Clone + ObjectType + 'static,
    S: Clone + SubscriptionType + 'static, 

pub fn new() -> Self

Creates a new builder. You’ll need to then call the other methods to set everything up.

pub fn ctx(self, ctx: C) -> Self

Defines the context to pass to all GraphQL resolvers. This is typically a database pool, but it can really be anything that can be safely sent between threads. If you don’t want to use context, you’ll need to set something here anyway (for now).

pub fn jwt_secret(self, jwt_secret: &str) -> Self

Defines the JWT secret that will be used to authenticate client tokens and communication with the subscriptions server. This should be randomly generated (see the book).

pub fn auth_block_state(
    self,
    authentication_block_state: AuthBlockLevel
) -> Self

Defines the blocklevel for the GraphQL endpoint. See AuthBlockLevel for more details.

pub fn schema(
    self,
    query_root: Q,
    mutation_root: M,
    subscription_root: S
) -> Self

Defines your custom schema. The query/mutation roots will be inserted into the queries/mutations server/function and the subscription root will be inserted into the subscriptions server. These should be specified using async_graphql as per the book.

pub fn use_subscriptions_server(self) -> Self

Explicitly enables the subscriptions server. You shouldn’t every need to call this, as calling any methods that define settings for the subscriptions server will automatically enable it.

pub fn subscriptions_server_hostname(
    self,
    subscriptions_server_hostname: &str
) -> Self

Defines the hsotname on which the subscriptions server will be contacted.

pub fn subscriptions_server_port(self, subscriptions_server_port: &str) -> Self

Defines the port on which the subscriptions server will be contacted.

pub fn subscriptions_server_endpoint(
    self,
    subscriptions_server_endpoint: &str
) -> Self

Defines the GraphQL endpoint for the subscriptions server. The GraphiQL playground endpoint inherits from the .playground_endpoint() setting.

pub fn jwt_to_connect_to_subscriptions_server(
    self,
    subscriptions_server_jwt_to_connect: &str
) -> Self

Specifies the JWT which will be used by the queries/mutations system to connect to the subscriptions server. This should be generated based off the same secret as you specify for the queries/mutations system (TODO security review of that architecture).

pub fn playground_endpoint(self, playground_endpoint: &str) -> Self

Defines the GraphiQL playground endpoint. In development, this is not required and will default to /graphiql. In production, if this has been set we’ll throw an error at .finish().

pub fn graphql_endpoint(self, graphql_endpoint: &str) -> Self

Defines the GraphQL endpoint. This is not required, and defaults to /graphql.

pub fn finish(self) -> Result<Options<C, Q, M, S>>

Builds the final options, consuming self. This will return an error if you haven’t set something required up.

Trait Implementations

impl<C: Clone, Q: Clone, M: Clone, S: Clone> Clone for OptionsBuilder<C, Q, M, S> where
    C: Any + Send + Sync + Clone,
    Q: Clone + ObjectType + 'static,
    M: Clone + ObjectType + 'static,
    S: Clone + SubscriptionType + 'static, 

fn clone(&self) -> OptionsBuilder<C, Q, M, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C, Q, M, S> Default for OptionsBuilder<C, Q, M, S> where
    C: Any + Send + Sync + Clone,
    Q: Clone + ObjectType + 'static,
    M: Clone + ObjectType + 'static,
    S: Clone + SubscriptionType + 'static, 

fn default() -> Self

Returns the “default value” for a type.