Struct CapabilityId 

pub struct CapabilityId(/* private fields */);

Capability identifier — an open, string-based ID.

IDs are open strings rather than variants in a central enum, so new capabilities can be added without database migrations or Everruns source edits. A stable identifier is made from ASCII letters, digits, _, -, ., or :, starts with a letter or _, and fits within 128 bytes; the __everruns_ namespace is reserved.

CapabilityId::new is infallible so persisted and in-flight values can be carried without re-validation; boundaries that accept new identifiers (Framework agent build, product write paths) enforce the grammar with validate_capability_id / CapabilityId::validate or the validating FromStr implementation.

Implementations

impl CapabilityId

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

Create a capability ID from a string without validating it.

Use this for values that were already validated at a boundary (or that predate validation). New identifiers should go through CapabilityId::parse or a boundary that calls validate_capability_id.

pub fn parse(id: impl Into<String>) -> Result<Self, CapabilityError>

Create a validated capability ID.

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

Validate this ID against the open-ID grammar and reserved namespaces.

pub fn as_str(&self) -> &str

Get the ID as a string slice.

pub fn into_string(self) -> String

Consume the ID and return the underlying string.

Trait Implementations

impl AsRef<str> for CapabilityId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for CapabilityId

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for CapabilityId

fn clone(&self) -> CapabilityId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilityId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CapabilityId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CapabilityId

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

Formats the value using the given formatter.

impl Eq for CapabilityId

impl From<&str> for CapabilityId

fn from(s: &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<String> for CapabilityId

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for CapabilityId

type Err = CapabilityError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CapabilityId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CapabilityId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for CapabilityId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for CapabilityId

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CapabilityId

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 CapabilityId