Struct GraphqlConfig 

#[non_exhaustive]
pub struct GraphqlConfig {

    pub enabled: bool,
    pub path: String,
    pub introspection: Toggle,
    pub sdl: Toggle,
    pub mask_unexpected_errors: Toggle,
    pub allow_get: bool,
    pub max_body_bytes: usize,
    pub timeout_ms: u64,
    pub slow_operation_ms: u64,
    pub csrf_prevention: bool,
    pub batching: BatchingConfig,
    pub limits: LimitsConfig,
    pub subscriptions: SubscriptionsConfig,
    pub persisted_queries: PersistedQueriesConfig,
    pub uploads: UploadsConfig,
}

The [graphql] section.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

Kill switch. false mounts nothing (the routes 404).

path: String

Mount path of the endpoint.

introspection: Toggle

Allow introspection (__schema, __type). auto = on in the dev and test profiles, off elsewhere. __typename is always allowed.

sdl: Toggle

Serve GET {path}/sdl. auto follows the effective introspection value: publishing the SDL is publishing the schema.

mask_unexpected_errors: Toggle

Replace the message of any resolver error that does not carry an extensions.code with Internal server error (the original is logged). auto = off in dev/test, on elsewhere.

allow_get: bool

Serve queries over GET {path}?query=…. Mutations over GET are always refused with 405.

max_body_bytes: usize

Largest accepted request body, in bytes (multipart uploads are bounded separately by [graphql.uploads]).

timeout_ms: u64

Per-operation execution timeout in milliseconds; 0 = none. Subscriptions are not timed out.

slow_operation_ms: u64

Operations slower than this (milliseconds) are logged at WARN; 0 = never.

csrf_prevention: bool

Require a preflight-forcing header (apollo-require-preflight, graphql-require-preflight or x-apollo-operation-name) on multipart requests, which browsers otherwise send cross-site without a CORS preflight.

batching: BatchingConfig

See BatchingConfig.

limits: LimitsConfig

See LimitsConfig.

subscriptions: SubscriptionsConfig

See SubscriptionsConfig.

persisted_queries: PersistedQueriesConfig

See PersistedQueriesConfig.

uploads: UploadsConfig

See UploadsConfig.

Implementations

impl GraphqlConfig

pub fn from_toml_str(text: &str, section: &str) -> Result<Self, ConfigError>

Parse the [section] table out of a whole autumn.toml document, with no profile layering and no environment overrides.

Errors

Returns ConfigError for invalid TOML, unknown keys, wrong types, or values validate rejects.

pub fn resolve(section: &str) -> Result<Resolved, ConfigError>

Resolve [section] from the host app’s configuration files and environment, exactly as Autumn core layers its own settings.

Errors

Returns ConfigError when a contributing file cannot be read or parsed, when the merged section has an unknown or ill-typed key, or when a value is out of range.

pub fn resolve_with_env( section: &str, env: &dyn Env, ) -> Result<Resolved, ConfigError>

Pure core of resolve, reading only env.

Errors

See resolve.

pub fn validate(&self) -> Result<(), ConfigError>

Reject values that would misbehave at runtime.

Errors

Returns ConfigError naming the offending key.

Trait Implementations

impl Clone for GraphqlConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphqlConfig

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

Formats the value using the given formatter.

impl Default for GraphqlConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GraphqlConfig

where GraphqlConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for GraphqlConfig

impl PartialEq for GraphqlConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for GraphqlConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GraphqlConfig