Skip to main content

Annotations

Struct Annotations 

Source
pub struct Annotations { /* private fields */ }
Expand description

A collection of protocol annotations with typed accessors.

Implementations§

Source§

impl Annotations

Source

pub fn new() -> Annotations

Create an empty annotation set.

Source

pub fn single(annotation: ProtocolAnnotation) -> Annotations

Create from a single annotation.

Source

pub fn from_vec(items: Vec<ProtocolAnnotation>) -> Annotations

Create from a vector of annotations.

Source

pub fn from_dsl_entries(entries: &[DslAnnotationEntry]) -> Annotations

Create from ordered raw DSL entries.

Entry order is preserved exactly. Known annotations are lowered to their typed variants; unknown entries remain Custom.

Source

pub fn from_dsl_map(map: &HashMap<String, String>) -> Annotations

Source

pub fn dsl_map(&self) -> HashMap<String, String>

Source

pub fn dsl_entries(&self) -> Vec<DslAnnotationEntry>

Return raw DSL entries in stable order.

Source

pub fn push(&mut self, annotation: ProtocolAnnotation)

Add an annotation.

Source

pub fn is_empty(&self) -> bool

Check if empty.

Source

pub fn len(&self) -> usize

Get the number of annotations.

Source

pub fn iter(&self) -> impl Iterator<Item = &ProtocolAnnotation>

Iterate over annotations.

Source

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut ProtocolAnnotation>

Iterate mutably over annotations.

Source

pub fn any<F>(&self, f: F) -> bool

Check if any annotation satisfies a predicate.

Source

pub fn find<F>(&self, f: F) -> Option<&ProtocolAnnotation>
where F: FnMut(&&ProtocolAnnotation) -> bool,

Find the first annotation satisfying a predicate.

Source

pub fn timed_choice(&self) -> Option<Duration>

Get timed choice annotation if present.

Source

pub fn has_timed_choice(&self) -> bool

Check if this has a timed choice annotation.

Source

pub fn priority(&self) -> Option<u32>

Get priority annotation if present.

Source

pub fn is_idempotent(&self) -> bool

Check if marked as idempotent.

Source

pub fn has_trace(&self) -> bool

Check if has any trace annotation.

Source

pub fn has_heartbeat(&self) -> bool

Check if has a heartbeat annotation.

Source

pub fn heartbeat(&self) -> Option<(Duration, u32)>

Get heartbeat parameters if present (interval, on_missing_count).

Source

pub fn has_runtime_timeout(&self) -> bool

Check if has a runtime timeout annotation.

Source

pub fn runtime_timeout(&self) -> Option<Duration>

Get runtime timeout duration if present.

Source

pub fn has_parallel(&self) -> bool

Check if has a parallel annotation.

Source

pub fn has_ordered(&self) -> bool

Check if has an ordered annotation.

Source

pub fn has_min_responses(&self) -> bool

Check if has a min_responses annotation.

Source

pub fn min_responses(&self) -> Option<u32>

Get min_responses value if present.

Source

pub fn custom(&self, key: &str) -> Option<&str>

Get a custom annotation value by key.

Source

pub fn custom_values(&self, key: &str) -> Vec<&str>

Get every custom annotation value for a key in source order.

Source

pub fn merge(&mut self, other: &Annotations)

Merge annotations from another set.

Source

pub fn clear(&mut self)

Clear all annotations.

Trait Implementations§

Source§

impl Clone for Annotations

Source§

fn clone(&self) -> Annotations

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Annotations

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Annotations

Source§

fn default() -> Annotations

Returns the “default value” for a type. Read more
Source§

impl FromIterator<ProtocolAnnotation> for Annotations

Source§

fn from_iter<I>(iter: I) -> Annotations

Creates a value from an iterator. Read more
Source§

impl<'a> IntoIterator for &'a Annotations

Source§

type Item = &'a ProtocolAnnotation

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, ProtocolAnnotation>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> <&'a Annotations as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
Source§

impl IntoIterator for Annotations

Source§

type Item = ProtocolAnnotation

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<ProtocolAnnotation>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> <Annotations as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for Annotations

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for Annotations

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> Endpoint for T
where T: Send,

Source§

impl<T> ProgramMessage for T
where T: Clone + Send + Sync + Debug,