Struct ServerConfig

pub struct ServerConfig {
    pub port: u16,
    pub address: String,
    pub highlight_sql: bool,
    pub instances: Vec<Instance>,
}

Configuration for the OmniOrchestrator server application.

This structure defines all the configurable parameters for the server, including network settings and behavior options. It supports serialization to and deserialization from JSON for persistent configuration.

The configuration can be loaded from a file or generated with default values if no configuration file exists.

Fields

port: u16

The port number on which the server will listen

address: String

The IP address to which the server will bind

highlight_sql: bool

Whether to apply syntax highlighting to SQL logs

instances: Vec<Instance>

List of other server instances in the cluster

Implementations

impl ServerConfig

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

Reads the server configuration from the config file.

Attempts to load the configuration from “config.json” in the current directory. If the file doesn’t exist or can’t be read, it creates a new configuration file with default values and returns those defaults.

Returns

• Ok(ServerConfig) - Successfully loaded or created configuration
• Err(ConfigError) - Failed to parse existing configuration

Error Handling

• If the file doesn’t exist, creates a default configuration
• If the file exists but can’t be parsed, returns a ParseError

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

Writes the current configuration to the config file.

Serializes the configuration to JSON and writes it to “config.json” in the current directory. This allows configuration changes to persist across server restarts.

Returns

• Ok(()) - Successfully wrote configuration to file
• Err(ConfigError) - Failed to serialize or write configuration

Error Handling

• Returns ParseError if serialization to JSON fails
• Returns FailedToWrite if writing to the file fails

pub fn write_default() -> Result<(), ConfigError>

Creates and writes a default configuration to the config file.

This is a convenience method that creates a ServerConfig with default values and writes it to the configuration file. It’s typically used when no configuration file exists yet.

Returns

• Ok(()) - Successfully wrote default configuration to file
• Err(ConfigError) - Failed to write default configuration

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl Default for ServerConfig

Default implementation for ServerConfig.

Provides reasonable default values for a server configuration to be used when no custom configuration is provided or when initializing a new configuration file.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ServerConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.