Struct OperatorRef 

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

The logical Operator role handle (main-ai, phase_a_op, …), re-exported here so it sits alongside SessionId — the other half of the operator-login identity pair — despite being defined one layer down.

It has to be defined in mlua-swarm-schema rather than in this module: crate::BindRequest carries one as binding_target, and that struct lives in the schema crate, which does not (and must not) depend on this one. Not to be confused with Role below, which is the closed authorization enum (Operator / Worker / Observer / Senior). Logical Operator role handle — the one type behind the three names the same concept used to carry: a Blueprint’s AgentDef.spec.operator_ref, a BindRequest::binding_target, and the roles a POST /v1/operators login mints.

Why a newtype and not String

Those three sites name one thing: “which Operator is meant”, written by the Blueprint author and claimed at login. Spelling it String everywhere let it be swapped at a call site with the several other strings that travel alongside it — an agent name, a session id, a launch variant — none of which the compiler could tell apart.

Deliberately not built from the id_newtype! macro: that shape mints <PREFIX>-<hex> values and validates the prefix, which fits a server-minted id like BindingDigest’s siblings. An OperatorRef is authored, not minted (main-ai, phase_a_op), so it carries no prefix and no generated form.

The only rule is “not empty”

No naming convention is imposed — every name an existing Blueprint already uses stays valid. An empty ref is rejected because it can only be a mistake: nothing can hold the role "", so it names no Operator and would fail later, further from the author who wrote it.

The wire form is unchanged: a plain string in both directions (#[serde(try_from = "String")] over a newtype, so serialization is the inner string verbatim and deserialization runs the emptiness check at the boundary).

Implementations

impl OperatorRef

pub fn new(name: impl Into<String>) -> Result<OperatorRef, EmptyOperatorRef>

Build a ref from an authored name, rejecting only the empty string.

pub fn as_str(&self) -> &str

View the ref as a string slice.

pub fn into_string(self) -> String

Consume the ref and return the inner string.

Trait Implementations

impl AsRef<str> for OperatorRef

fn as_ref(&self) -> &str

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

impl Borrow<str> for OperatorRef

Lets a HashMap<OperatorRef, _> be probed with a plain &str, so a lookup does not have to allocate (or fallibly construct) a ref first.

Sound because the derived Hash / Eq on this newtype are exactly the inner String’s, which are in turn str’s — the Borrow contract’s requirement that borrowed and owned forms hash and compare identically.

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for OperatorRef

fn clone(&self) -> OperatorRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OperatorRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OperatorRef

fn deserialize<__D>( __deserializer: __D, ) -> Result<OperatorRef, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OperatorRef

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

Formats the value using the given formatter.

impl Eq for OperatorRef

impl FromStr for OperatorRef

type Err = EmptyOperatorRef

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<OperatorRef, EmptyOperatorRef>

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

impl Hash for OperatorRef

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

where __H: Hasher,

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 Ord for OperatorRef

fn cmp(&self, other: &OperatorRef) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for OperatorRef

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for OperatorRef

fn partial_cmp(&self, other: &OperatorRef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for OperatorRef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OperatorRef

impl TryFrom<String> for OperatorRef

type Error = EmptyOperatorRef

The type returned in the event of a conversion error.

fn try_from(name: String) -> Result<OperatorRef, EmptyOperatorRef>

Performs the conversion.