Skip to main content

Crate everruns_platform

Crate everruns_platform 

Source
Expand description

Moved. Hosted capabilities now live in everruns-capabilities. Part of the Everruns ecosystem. Control-plane records belong to the server. This deprecated shim ships once.

use everruns_capabilities::capabilities::hosted_capability_registry;
let _registry = hosted_capability_registry();

Modules§

background_run
Immediate and scheduled background tool runs.
capabilities
Hosted product capabilities.
channel_message_sender
Slack implements the neutral message-sender contract through the existing endpoint action service. The same adapter works for direct and remote hosts.
connector
Extension contracts are owned by everruns-contracts.
host_extension
Adapter from hosted platform services to the neutral execution-host seams.
knowledge_store
Extension contracts are owned by everruns-contracts.
memory
Runtime mount configuration for the hosted memory capability.
platform_store
sandbox_checkpoint
Hosted adapters for sandbox checkpoint contracts.
sandbox_state
Durable logical-sandbox and physical-incarnation state.
session_mutator
Backend-neutral mutation contract for session metadata.
session_sandbox
Hosted lifecycle orchestration for session-owned managed sandboxes.
session_sqldb
Extension contracts are owned by everruns-contracts.
slack_action
Session-bound Slack effects; credentials stay with the control plane. The seam a Slack-native capability acts through (EVE-1024).
vector_store
Extension contracts are owned by everruns-contracts.

Structs§

ColumnSchema
Schema of a column.
ConnectorPlugin
Descriptor an integration crate publishes for one of its connectors.
ConnectorRegistry
Registry of connection providers available to a platform.
ConnectorRegistryBuilder
Builder for creating a ConnectorRegistry.
ConnectorValidation
Result of credential validation.
DatabaseInfo
Metadata about a session database (no content/pages).
DurableToolResultStoreExt
Read access to durable tool-call state, installed on the extension seam. Reconciliation checks whether the tool call that produced a checkpoint committed before allowing its workspace revision to become authoritative.
EmbeddingCallUsage
Usage from a single embedding call made while serving a retrieval query.
FormField
A single form field.
InMemoryVectorStore
In-memory brute-force VectorStore for dev mode and storage-parity tests.
KnowledgeIndexCitation
A single retrieved chunk returned by KnowledgeIndexSearch::search, shaped to the search_index citation contract in knowledge/runtime-resources/knowledge-indexes.md. The id (kchk_…) + source_uri + location give the agent a stable, linkable citation. Kept compatible with the planned search_knowledge citation shape so the UI can render both uniformly.
KnowledgeIndexSearchExt
Typed tool-context extension for Knowledge Index retrieval.
KnowledgeIndexSearchOutcome
Citations plus the embedding usage incurred to produce them.
KnowledgeSearchHit
One ranked hit from an organization Knowledge Base search.
KnowledgeStoreExt
Typed tool-context extension for Knowledge Base retrieval.
MemoryConfig
Top-level config for the memory capability.
MemoryMountConfig
Capability config entry for memory. One entry per mount.
NewSandboxCheckpoint
A checkpoint upload that has completed but is not yet authoritative.
PlatformCreateSessionRequest
Options for delegate-backed child-session creation from model-facing tools.
PlatformMessage
Simplified message representation for subagent/handoff result collection.
PlatformStoreExt
Moved to everruns_capabilities::PlatformStoreExt. Typed ToolContext extension carrying the hosted PlatformStore (EVE-839). Replaces the former ToolContext::platform_store field; hosted capabilities resolve it via context.extension::<PlatformStoreExt>().
PlatformStoreSubagentDelegate
Adapter implementing core’s narrow SubagentSessionDelegate over a runtime-only PlatformStore, so hosted subagent/handoff orchestration can drive child sessions without depending on the hosted seam.
PlatformToolAugmentor
Hosted tool policy installed into everruns-host by platform compositions.
SandboxCheckpoint
A recorded workspace revision.
SandboxCheckpointStoreExt
Type-keyed wrapper installed on the tool context by hosted presets.
SandboxRef
Identity and fencing state of a logical sandbox.
SandboxStateStoreExt
Hosted store installed on everruns_core::ToolContext as a typed extension. Framework/remote hosts that do not install it retain the legacy session-secret fallback.
SessionMutatorExt
Type-keyed wrapper installed on the tool context by hosted presets.
SessionSandboxConfig
Session sandbox configuration.
SessionSandboxExecRequest
Provider-neutral exec request.
SessionSandboxExecResponse
Provider-neutral exec result.
SessionSandboxInitConfig
One-time sandbox initialization.
SessionSandboxInstance
Provider-owned physical environment instance record.
SessionSandboxProviderPlugin
Inventory registration point for concrete session sandbox providers.
SessionSandboxReadFileResponse
Provider-neutral file read result.
SessionSandboxState
Persisted managed environment state.
SessionSandboxStatusResponse
Provider-neutral status view.
SessionSandboxWriteFileResponse
Provider-neutral file write result.
SessionSqlDbStoreExt
Type-keyed wrapper installed on the tool context by hosted presets.
SlackActionInvokerExt
ToolContextExtensions handle for SlackActionInvoker.
SqlExecuteResult
Result of an INSERT/UPDATE/DELETE/DDL statement.
SqlQueryResult
Result of a SELECT query.
TableSchema
Schema of a table.
VectorMatch
A ranked match returned from VectorStore::query.
VectorQuery
A retrieval request against a single namespace. At least one of vector (semantic KNN) or text (BM25) must be set; when both are present the backend fuses them with reciprocal-rank fusion.
VectorRecord
A single point stored in the vector store, keyed by the chunk public_id (kchk_…), which is also the stable citation id.
VectorStoreExt
Type-keyed wrapper installed on a host composition by hosted presets. Core carries the generic extension bag but does not name the Knowledge Index service.

Enums§

ConnectorType
How the user provides credentials for this connection.
FieldType
Input field type for rendering.
MemoryMountAccess
Mount access mode. Defaults to ReadOnly when omitted from config.
SandboxCheckpointError
SandboxCheckpointKind
How a checkpoint’s bytes are stored.
SandboxStateError
SessionSandboxStatus
Runtime lifecycle status of the managed sandbox.
SessionSqlDbError
Error type for session SQL database operations.
SlackAction
One thing an agent can ask its own Slack endpoint to do.
SlackActionError
Why an action did not happen.
SlackActionOutcome
What an action produced, shaped for a tool result.

Constants§

DEFAULT_SESSION_SANDBOX_IDLE_TIMEOUT_SECS
Default idle timeout for auto-pausing the managed sandbox.
MAX_CHECKPOINT_COLLECT_LIMIT
Hard upper bound on one garbage-collection batch (TM-DOS). Caps the destructive collect_unattached_checkpoints regardless of caller input, so a misconfigured limit cannot request an unbounded delete; large backlogs drain over successive sweeps. Mirrors MAX_RETENTION_PRUNE_LIMIT in the server storage backend.
SESSION_SANDBOX_CAPABILITY_ID
Capability id for the managed session sandbox capability.
SESSION_SANDBOX_SECRET_NAME
Secret name used to persist the managed sandbox record for a session.

Traits§

Connector
A connection provider that can validate credentials and describe its UI form.
KnowledgeIndexSearch
Server-implemented hybrid retrieval over an org’s bound Knowledge Indexes.
KnowledgeStore
Tenant-scoped search over curated Knowledge Bases.
PlatformHostBackendsExt
Adds a hosted platform store to an embedded host without introducing a host -> platform dependency.
PlatformStore
Hosted command and delegation services, phrased entirely in runtime views.
SandboxCheckpointStore
Persistence for logical sandboxes and their checkpoints.
SandboxPersistenceStore
One hosted implementation normally owns logical identity, incarnation state, and checkpoint lineage in the same database.
SandboxStateStore
Persistence for the current physical incarnation of a logical sandbox.
SessionMutator
Trait for updating mutable session metadata.
SessionSandboxProvider
Provider trait implemented by integration crates.
SessionSqlDbStore
Async trait for session-scoped SQL database operations.
SlackActionInvoker
Performs SlackActions as one session’s own Slack endpoint bot.
VectorStore
Pluggable embedding store for Knowledge Indexes. Selected through HostComposition; the in-memory backend backs dev/tests, Turbopuffer is the reference production backend.

Functions§

create_session_sandbox_provider
Look up a registered provider by id.
delete_session_sandbox
Delete the managed sandbox if it exists.
delete_session_sandbox_state
Delete managed environment state after its provider resource is released.
ensure_session_sandbox_running
Start the managed sandbox when absent and resume it when paused.
index_namespace
Derive the vector-store namespace for an index.
load_session_sandbox_state
Load managed environment state from durable hosted storage, adopting a legacy session-secret record on first access when necessary.
pause_session_sandbox
Pause the managed sandbox if it exists and is running.
run_session_sandbox_init_if_needed
Execute one-time initialization commands when configured and not yet completed.
save_session_sandbox_state
Persist managed environment state. Hosted PostgreSQL contexts use first-class logical/instance rows; portable hosts retain the legacy secret fallback until they install a SandboxStateStore.
session_sandbox_config_from_capabilities
Extract the effective session sandbox config from a capability list.
session_sandbox_tool_hints
Shared hints for stateful remote sandbox tools.
validate_memory_config
Validate a full memory capability config: per-entry shape + duplicate / overlapping path detection.
validate_mount_config_shape
Validation outcome for a single mount config entry.

Type Aliases§

ConnectorFormSchema
Credential form schema for connectors.
KnowledgeIndexSearchHit
Citation result returned by the hosted Knowledge Index search service.
PlatformStoreFactory
Factory producing a platform store scoped to one organization and session.