Skip to main content

RuntimeConfig

Struct RuntimeConfig 

Source
pub struct RuntimeConfig {
Show 20 fields pub server: HttpServerConfig, pub database: DatabaseConfig, pub webhooks: HashMap<String, WebhookRouteConfig>, pub files: HashMap<String, FileConfig>, pub auth: Option<AuthConfig>, pub notifications: Option<NotificationsConfig>, pub observers: HashMap<String, ObserverConfig>, pub interceptors: HashMap<String, Vec<String>>, pub rate_limiting: Option<RateLimitingConfig>, pub cors: Option<CorsConfig>, pub metrics: Option<MetricsConfig>, pub tracing: Option<TracingConfig>, pub logging: Option<LoggingConfig>, pub storage: HashMap<String, StorageConfig>, pub search: Option<SearchConfig>, pub cache: Option<CacheConfig>, pub queues: Option<QueueConfig>, pub realtime: Option<RealtimeConfig>, pub custom_endpoints: Option<CustomEndpointsConfig>, pub lifecycle: Option<LifecycleConfig>,
}
Expand description

Root configuration structure loaded from fraiseql.toml.

Fields§

§server: HttpServerConfig

HTTP server binding, TLS, and connection-limit settings.

§database: DatabaseConfig

Primary database connection and pool settings.

§webhooks: HashMap<String, WebhookRouteConfig>

Named webhook route configurations, keyed by route name.

§files: HashMap<String, FileConfig>

Named file-upload route configurations, keyed by route name.

§auth: Option<AuthConfig>

Optional JWT authentication and OAuth provider configuration.

§notifications: Option<NotificationsConfig>

Reserved: placeholder for future notification system configuration.

§observers: HashMap<String, ObserverConfig>

Event observer configurations, keyed by observer name.

§interceptors: HashMap<String, Vec<String>>

Request interceptor chains, keyed by interceptor name.

§rate_limiting: Option<RateLimitingConfig>

Optional rate-limiting rules and backpressure thresholds.

§cors: Option<CorsConfig>

Optional CORS origin and header policy.

§metrics: Option<MetricsConfig>

Optional Prometheus metrics and SLO tracking configuration.

§tracing: Option<TracingConfig>

Optional distributed-tracing (OTLP/Jaeger) configuration.

§logging: Option<LoggingConfig>

Optional structured-logging configuration.

§storage: HashMap<String, StorageConfig>

Named object-storage backend configurations, keyed by storage name.

§search: Option<SearchConfig>

Reserved: placeholder for future search-indexing configuration.

§cache: Option<CacheConfig>

Reserved: placeholder for future advanced caching strategy configuration.

§queues: Option<QueueConfig>

Reserved: placeholder for future job-queue configuration.

§realtime: Option<RealtimeConfig>

Reserved: placeholder for future real-time update configuration.

§custom_endpoints: Option<CustomEndpointsConfig>

Reserved: placeholder for future custom-endpoint configuration.

§lifecycle: Option<LifecycleConfig>

Graceful-shutdown timing and health-check endpoint paths.

Implementations§

Source§

impl RuntimeConfig

Source

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, ConfigError>

Load configuration from file with full validation

§Errors

Returns ConfigError::ReadError if the file cannot be read. Returns ConfigError::ParseError if the file content is not valid TOML. Returns ConfigError if validation fails or required environment variables are missing.

Source

pub fn load() -> Result<Self, ConfigError>

Load configuration from default locations

§Errors

Returns ConfigError::NotFound if no configuration file is found in any default location. Returns ConfigError if the found file cannot be read, parsed, or fails validation.

Source

pub fn load_with_path(path: Option<&Path>) -> Result<Self, ConfigError>

Load configuration with optional file path (CLI argument)

§Errors

Returns ConfigError if loading from the given path or from default locations fails.

Source

pub fn validate_syntax(content: &str) -> Result<(), ConfigError>

Validate configuration without loading env vars (for dry-run/testing)

§Errors

Returns ConfigError::ParseError if the content is not valid TOML or cannot be deserialized.

Trait Implementations§

Source§

impl Clone for RuntimeConfig

Source§

fn clone(&self) -> RuntimeConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RuntimeConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for RuntimeConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,