Struct VibeEngineConfig 

pub struct VibeEngineConfig {
    pub platform_type: VibePlatformType,
    pub store_root_path: PathBuf,
    pub is_encrypt: bool,
    pub app: VibeAppConfig,
    pub log: VibeLogConfig,
    pub store: VibeStoreConfig,
    pub runtime: VibeRuntimeConfig,
}

Configuration used to create a VibeEngine. Configuration used when creating a crate::VibeEngine.

Fields

platform_type: VibePlatformType

Platform identifier used by integrations and logs.

store_root_path: PathBuf

Root directory where vibe-ready stores app data.

is_encrypt: bool

Whether persistent stores should use encryption when supported.

app: VibeAppConfig

Application identity used for namespacing local data.

log: VibeLogConfig

Logging backend and retention configuration.

store: VibeStoreConfig

Work-store backend and storage configuration.

runtime: VibeRuntimeConfig

Runtime worker and queue configuration.

Implementations

impl VibeEngineConfig

pub fn builder() -> VibeEngineConfigBuilder

Starts building a VibeEngineConfig with production-ready defaults.

Returns

A VibeEngineConfigBuilder that can be customized before calling VibeEngineConfigBuilder::build.

Examples

use vibe_ready::{VibeEngineConfig, VibePlatformType};

let config = VibeEngineConfig::builder()
    .platform(VibePlatformType::MacOS)
    .app_name("demo")
    .namespace("examples")
    .build();
assert_eq!(config.app_name(), "demo");

pub fn store_path(&self) -> &PathBuf

Returns the configured root directory for SDK data.

Returns

A borrowed PathBuf pointing to the storage root.

pub fn is_encrypt(&self) -> bool

Returns whether storage encryption was requested.

Returns

true when encryption is enabled in the store configuration.

pub fn platform(&self) -> VibePlatformType

Returns the configured platform identifier.

Returns

The VibePlatformType stored in this configuration.

pub fn app_name(&self) -> &str

Returns the application name used for data isolation.

Returns

A borrowed application name string.

pub fn namespace(&self) -> &str

Returns the namespace used for data isolation.

Returns

A borrowed namespace string.

pub fn log_config(&self) -> &VibeLogConfig

Returns the logging configuration.

Returns

A borrowed VibeLogConfig.

pub fn store_config(&self) -> &VibeStoreConfig

Returns the storage configuration.

Returns

A borrowed VibeStoreConfig.

pub fn runtime_config(&self) -> &VibeRuntimeConfig

Returns the runtime configuration.

Returns

A borrowed VibeRuntimeConfig.

pub fn app_store_path(&self) -> PathBuf

Builds the app-specific storage directory path.

Returns

store_root_path / namespace / app_name as a PathBuf.

Examples

use std::path::PathBuf;
use vibe_ready::VibeEngineConfig;

let config = VibeEngineConfig::builder()
    .store_root_path("/tmp/vibe-ready")
    .namespace("dev")
    .app_name("app")
    .build();
assert_eq!(config.app_store_path(), PathBuf::from("/tmp/vibe-ready/dev/app"));

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

Validates identifiers, backend availability, and runtime capacities.

Returns

Ok(()) when the configuration can be used to create an engine, or VibeEngineError with configuration context when invalid.

Trait Implementations

impl Clone for VibeEngineConfig

fn clone(&self) -> VibeEngineConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VibeEngineConfig

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

Formats the value using the given formatter.

impl Display for VibeEngineConfig

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

Formats the value using the given formatter.