Struct SubjectRef 

pub struct SubjectRef { /* private fields */ }

Re-export canonical pack value types used by core public structs. Typed reference to the subject a fact, proposal, intent, or citation is about.

ActorId answers “who”; ContextKey answers “where in the convergence state”; SubjectRef answers “what object is being reasoned about.” The canonical wire form is scheme://kind/id, where scheme is the owning app or domain, kind is an app-owned noun, and id is opaque to Converge.

Implementations

impl SubjectRef

pub fn new( scheme: impl Into<String>, kind: impl Into<String>, id: impl Into<String>, ) -> Result<SubjectRef, SubjectRefError>

Creates a typed subject reference after validating and normalizing its structural parts.

scheme and kind are normalized to ASCII lowercase. id is preserved exactly after validation because apps own its semantics.

pub fn parse(value: &str) -> Result<SubjectRef, SubjectRefError>

Parses the canonical scheme://kind/id wire form.

pub fn scheme(&self) -> &str

Returns the subject scheme, usually the owning app or domain id.

pub fn kind(&self) -> &str

Returns the app-owned subject kind.

pub fn id(&self) -> &str

Returns the app-owned subject id.

pub fn to_uri(&self) -> String

Renders the canonical scheme://kind/id wire form.

Trait Implementations

impl Clone for SubjectRef

fn clone(&self) -> SubjectRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubjectRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SubjectRef

fn deserialize<D>( deserializer: D, ) -> Result<SubjectRef, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SubjectRef

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

Formats the value using the given formatter.

impl Eq for SubjectRef

impl FromStr for SubjectRef

type Err = SubjectRefError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<SubjectRef, <SubjectRef as FromStr>::Err>

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

impl Hash for SubjectRef

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 SubjectRef

fn cmp(&self, other: &SubjectRef) -> 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 SubjectRef

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SubjectRef

fn partial_cmp(&self, other: &SubjectRef) -> 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 SubjectRef

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 SubjectRef