Struct CapabilityRef 

pub struct CapabilityRef { /* private fields */ }

A reference to a capability implementation plus per-agent JSON.

This is the one semantic model for “a capability attached to an agent”: the Framework activates it, the product persists it (the historical AgentCapabilityConfig attachment row and BuiltInCapabilityDefinition provisioning entry are this type), and worker resolution consumes it. It serializes as {"ref": "<id>", "config": {…}} everywhere.

IDs are open strings rather than variants in a central enum. They must use a stable identifier made from ASCII letters, digits, _, -, ., or :, start with a letter or _, and fit within 128 bytes. The __everruns_ namespace is reserved.

Configuration defaults to {} and must be a JSON object. Boundaries that accept new values (Framework agent build, product write paths) enforce both rules via CapabilityRef::validate; the referenced implementation owns the inner schema.

Configuration is redacted from Debug, but it is not a secret store: hosts may persist or otherwise inspect it. Put credentials in a provider-owned secret mechanism and pass only a non-secret handle here.

Implementations

impl CapabilityRef

pub fn new(id: impl Into<CapabilityId>) -> Self

Reference a stable capability ID with default ({}) configuration.

pub fn with_config(id: impl Into<CapabilityId>, config: Value) -> Self

Reference a capability ID with explicit configuration.

pub fn config(self, config: impl Into<Value>) -> Self

Attach implementation-defined per-agent JSON configuration.

Validation is deferred to the consuming boundary (e.g. the Framework’s AgentBuilder::build) so capability values remain easy to compose and pass through application configuration layers.

pub fn id(&self) -> &str

The stable capability identifier.

pub fn capability_id(&self) -> &str

The stable capability identifier (alias of CapabilityRef::id).

pub fn typed_id(&self) -> &CapabilityId

The typed capability identifier.

pub fn config_value(&self) -> &Value

The implementation-defined JSON configuration.

pub fn config_mut(&mut self) -> &mut Value

Mutable access to the configuration (host hydration paths).

pub fn set_config(&mut self, config: impl Into<Value>)

Replace the configuration in place.

pub fn set_id(&mut self, id: impl Into<CapabilityId>)

Replace the identifier in place (host alias-canonicalization paths).

pub fn into_parts(self) -> (CapabilityId, Value)

Split the reference into its identity and configuration.

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

Validate the identifier grammar and the JSON object config boundary.

Trait Implementations

impl Clone for CapabilityRef

fn clone(&self) -> CapabilityRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilityRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CapabilityRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CapabilityRef

impl From<&str> for CapabilityRef

fn from(id: &str) -> Self

Converts to this type from the input type.

impl From<CapabilityId> for CapabilityRef

fn from(id: CapabilityId) -> Self

Converts to this type from the input type.

impl From<CapabilityRef> for CapabilitySpec

fn from(reference: CapabilityRef) -> Self

Converts to this type from the input type.

impl From<String> for CapabilityRef

fn from(id: String) -> Self

Converts to this type from the input type.

impl IntoCapability for CapabilityRef

fn into_capability(self) -> CapabilitySpec

Consume the value and return its normalized specification.

impl PartialEq for CapabilityRef

fn eq(&self, other: &CapabilityRef) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CapabilityRef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CapabilityRef