Skip to main content

Annotations

Struct Annotations 

Source
pub struct Annotations {
    pub audience: Vec<Role>,
    pub priority: Option<f64>,
    pub last_modified: Option<String>,
    pub extensions: Extensions,
}
Expand description

Annotations, added in 2025-03-26 (PR #185).

Modeled rather than dropped, because they are advisory metadata a client uses to decide how to present a result, and a tool that says it is read-only means something to the caller.

Not Eq, and neither is anything that holds one: priority is a floating-point number and neither f32 nor f64 is a valid Eq type, because of NaN. The cost is that a content block cannot be a HashMap key, which nothing needs — blocks live in a Vec inside a result.

priority is f64 rather than the f32 that would be conventional for a 0.0–1.0 quantity, because every revision’s generated Annotations spells it f64 and this crate’s whole job is to carry a peer’s value through unchanged. Narrowing on the way in and widening on the way out is not a round trip: 0.1_f32 is not 0.1_f64, and a bridge forwarding annotations would quietly change a number the sender chose.

Fields§

§audience: Vec<Role>

The audience this block is meant for.

§priority: Option<f64>

How important this block is, 0.0–1.0.

f64 to match the wire exactly; see the type’s docs.

§last_modified: Option<String>

The last time the resource was modified, ISO 8601.

§extensions: Extensions

Unmodelled fields.

Implementations§

Source§

impl Annotations

Source

pub fn required_features(&self) -> FeatureSet

What these annotations need.

Annotations as a field need nothing: 2024-11-05 carries an untyped annotations on every content block, so a block with an audience and a priority lowers onto it and the value survives as JSON. That is why this is not Feature::ToolAnnotations, which gates the typed form added in 2025-03-26.

lastModified is different in kind, not degree. It exists only in the typed object, so an older revision cannot hold it at all — not as a field, not even untyped — and dropping it would lose information the sender put there. So it, and only it, requires 2025-06-18.

Source§

impl Annotations

Source

pub const fn empty() -> Self

Annotations with nothing set.

Trait Implementations§

Source§

impl Clone for Annotations

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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

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

impl Default for Annotations

Source§

fn default() -> Self

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

impl PartialEq for Annotations

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<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