Crate vibe_ready 

Project foundations for vibe-coding applications.

vibe-ready provides a small runtime layer for applications that need a ready-to-use engine, async task execution, scheduled work, structured logging, and a key-value store without assembling those pieces from scratch. Most applications start by building a VibeEngineConfig, creating a VibeEngine, and then using the engine for tasks, callbacks, and storage.

Examples

use vibe_ready::{VibeEngine, VibeEngineConfig, VibePlatformType, VibeResult};

fn main() -> VibeResult<()> {
    let config = VibeEngineConfig::builder()
        .platform(VibePlatformType::MacOS)
        .app_name("demo-app")
        .namespace("examples")
        .build();

    let engine = VibeEngine::create(config)?;
    engine.store().set_str("status", "ready")?;
    engine.destroy_with_timeout(std::time::Duration::from_secs(2))?;
    Ok(())
}

Modules

platform

Cross-platform helpers for task spawning and time.

prelude

Common imports for applications using vibe-ready.

Macros

array_to_json_string

Converts an array-like value to a JSON string.

basic_type_map_to_json_string

Converts a string-keyed map of basic serializable values to JSON.

err

Logs an error with a backtrace and returns the same error expression.

impl_display_json

Implements Display for serializable types by rendering JSON.

log_e

Emits an error-level structured log entry.

log_e_

Emits an error-level structured log entry with an extension segment.

log_i

Emits an info-level structured log entry.

log_i_

Emits an info-level structured log entry with an extension segment in the tag.

log_r

Emits a debug-level read-style structured log entry.

log_r_

Emits a debug-level read-style structured log entry with an extension segment.

log_s

Emits a debug-level state-style structured log entry.

log_s_

Emits a debug-level state-style structured log entry with an extension segment.

log_t

Emits an info-level trace-style structured log entry.

log_t_

Emits an info-level trace-style structured log entry with an extension segment.

obj_array_to_json_string

Converts displayable objects to a JSON-array-like string using Display.

Structs

VibeAppConfig

Application identity used to isolate SDK data on disk. Application identity used to isolate SDK data on disk.

VibeCallbackExecutor

Callback executor returned by VibeEngineExecutor::callback. Executes user callbacks on the engine callback thread pool.

VibeCancellationToken

Cooperative cancellation token consumed by scheduled tasks. Cooperative cancellation token passed to scheduled tasks.

VibeCapabilities

Build-time capabilities available in the current crate build. Build-time capabilities available in the current vibe-ready crate build.

VibeDbClient

Database client exposed for advanced integrations. Client used by the SDK to coordinate database worker operations.

VibeDbErrorInfo

Database error details exposed for advanced integrations. Detailed database error information for diagnostics.

VibeEngine

Main entry point for creating and driving a vibe-ready runtime. Main runtime facade for task execution, logging, and SDK context access.

VibeEngineConfig

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

VibeEngineConfigBuilder

Builder for VibeEngineConfig. Builder for VibeEngineConfig.

VibeEngineContext

Low-level context shared by engine services. Low-level context shared by engine services.

VibeEngineError

Error type returned by vibe-ready operations. Error returned by vibe-ready operations.

VibeEngineExecutor

Task executor used internally by VibeEngine and exposed for advanced integrations. Executes futures and callbacks on the engine-owned runtime infrastructure.

VibeKvBucket

Bucket-scoped view of VibeKvStore. Bucket-scoped view of VibeKvStore.

VibeKvChange

Change notification dispatched to KV listeners. Description of a change applied to the KV store, delivered to listeners registered via VibeKvStore::on_change / VibeKvBucket::on_change.

VibeKvListenerId

Cancellation handle returned by VibeKvStore::on_change. Identifier returned by VibeKvStore::on_change used to cancel a listener.

VibeKvStore

High-level key-value store facade. High-level key-value store facade backed by the configured SDK store backend.

VibeKvTx

Buffered transaction handle used inside VibeKvStore::transaction. Buffered transaction handle accumulating writes that are committed atomically.

VibeLogConfig

Logging behavior used by the SDK. Logging behavior used by the SDK.

VibeLogInfo

Log entry delivered to log listeners. Structured SDK log record.

VibeLogger

Low-level logger used by the engine log subsystem. Low-level logger that writes SDK log records and dispatches log listeners.

VibeRuntimeConfig

Runtime sizing and queue capacity used by VibeEngine. Runtime sizing and queue capacity used by crate::VibeEngine.

VibeStatusManager

Runtime status manager exposed for advanced integrations. Tracks and publishes connection status changes.

VibeStoreConfig

Storage behavior used by the SDK. Storage behavior used by the SDK.

VibeTableKeyVal

Key-value row returned by advanced database APIs. Database row representation for a key-value item.

VibeTaskHandle

Handle returned by VibeEngine::schedule_after / schedule_every / post_with_priority. Handle returned by every scheduling API.

VibeTaskInfo

Snapshot of a scheduler-tracked task. Snapshot of a scheduler-tracked task, returned by VibeTaskPanel::list.

VibeTaskPanel

Diagnostic panel listing live scheduler tasks. Diagnostic snapshot of all live tasks owned by the engine scheduler.

Enums

DbError

Database error category used by storage backends. Database error category used by storage backends.

VibeBackupStrategy

Backup behavior for SDK managed storage. Backup behavior for SDK managed storage.

VibeConnectionStatus

Connection state reported by the SDK runtime. Connection lifecycle state used by status integrations.

VibeEngineState

Lifecycle state of a VibeEngine. Lifecycle state of a VibeEngine.

VibeErrorCode

Stable error code used by VibeError. Stable numeric error codes returned by vibe-ready.

VibeErrorKind

High-level error category returned by VibeEngineError. High-level category for a VibeEngineError.

VibeKvChangeKind

Variant of VibeKvChange indicating whether a key was set or removed. Operation kind delivered by KV change listeners.

VibeKvValue

High-level value accepted by the SDK key-value store. Value stored in the high-level key-value store.

VibeLogBackend

Log backend selected for SDK log persistence. Log backend selected for SDK log persistence.

VibeLogLevel

Log severity used by the SDK. Severity level for SDK log records.

VibePlatformType

Platform identifier used by VibeEngineConfig. Platform where the SDK is running.

VibeStoreBackend

Store backend selected for SDK persistence. Store backend selected for SDK persistence.

VibeTaskKind

Origin category of a scheduler-tracked task. Static category describing how a task was scheduled.

VibeTaskPriority

Priority lane used by the task scheduler. Priority lane used by crate::VibeEngine::post_with_priority and friends.

VibeTaskState

Lifecycle state of a scheduler-tracked task. Lifecycle state of a scheduler-tracked task.

Statics

CODE_STR

Standard log field for error codes. Standard structured-log field name for error or status codes.

DESC

Standard log field for descriptions. Standard structured-log field name for human-readable descriptions.

RET_STR

Standard log field for return values. Standard structured-log field name for return values.

Type Aliases

VibeError

Short alias for VibeEngineError.

VibeLogListener

Log listener callback type. Callback invoked when a log record is emitted.

VibeResult

Result alias used by vibe-ready public APIs.