ServerNotification

Enum ServerNotification 

Source
pub enum ServerNotification {
    Cancelled {
        request_id: Option<RequestId>,
        reason: Option<String>,
        _meta: Option<HashMap<String, Value>>,
    },
    Progress {
        progress_token: ProgressToken,
        progress: f64,
        total: Option<f64>,
        message: Option<String>,
        _meta: Option<HashMap<String, Value>>,
    },
    LoggingMessage {
        level: LoggingLevel,
        logger: Option<String>,
        data: Value,
        _meta: Option<HashMap<String, Value>>,
    },
    ResourceUpdated {
        uri: String,
        _meta: Option<HashMap<String, Value>>,
    },
    ResourceListChanged {
        _meta: Option<HashMap<String, Value>>,
    },
    ToolListChanged {
        _meta: Option<HashMap<String, Value>>,
    },
    PromptListChanged {
        _meta: Option<HashMap<String, Value>>,
    },
    ElicitationComplete {
        elicitation_id: String,
    },
    TaskStatus {
        params: TaskStatusNotificationParams,
    },
}
Expand description

Notifications sent from the server to the client

Variants§

§

Cancelled

This notification can be sent by either side to indicate that it is cancelling a previously-issued request.

The request SHOULD still be in-flight, but due to communication latency, it is always possible that this notification MAY arrive after the request has already finished.

This notification indicates that the result will be unused, so any associated processing SHOULD cease.

A client MUST NOT attempt to cancel its initialize request.

Fields

§request_id: Option<RequestId>

The ID of the request to cancel.

§reason: Option<String>

An optional string describing the reason for the cancellation.

§

Progress

Fields

§progress_token: ProgressToken

The progress token which was given in the initial request.

§progress: f64

The progress thus far.

§total: Option<f64>

Total number of items to process, if known.

§message: Option<String>

An optional message describing the current progress.

§

LoggingMessage

Notification of a log message passed from server to client. If no logging/setLevel request has been sent from the client, the server MAY decide which messages to send automatically.

Fields

§level: LoggingLevel

The severity of this log message.

§logger: Option<String>

An optional name of the logger issuing this message.

§data: Value

The data to be logged.

§

ResourceUpdated

A notification from the server to the client, informing it that a resource has changed and may need to be read again. This should only be sent if the client previously sent a resources/subscribe request.

Fields

§uri: String

The URI of the resource that has been updated.

§

ResourceListChanged

An optional notification from the server to the client, informing it that the list of resources it can read from has changed. This may be issued by servers without any previous subscription from the client.

Fields

§

ToolListChanged

An optional notification from the server to the client, informing it that the list of tools it offers has changed. This may be issued by servers without any previous subscription from the client.

Fields

§

PromptListChanged

An optional notification from the server to the client, informing it that the list of prompts it offers has changed. This may be issued by servers without any previous subscription from the client.

Fields

§

ElicitationComplete

An optional notification from the server to the client, informing it of completion of an out-of-band elicitation request.

Fields

§elicitation_id: String

The ID of the elicitation that completed.

§

TaskStatus

An optional notification informing that a task’s status has changed.

Implementations§

Source§

impl ServerNotification

Source

pub fn cancelled(request_id: Option<RequestId>, reason: Option<String>) -> Self

Create a new Cancelled notification

Source

pub fn progress( progress_token: ProgressToken, progress: f64, total: Option<f64>, message: Option<String>, ) -> Self

Create a new Progress notification

Source

pub fn logging_message( level: LoggingLevel, logger: Option<String>, data: Value, ) -> Self

Create a new LoggingMessage notification

Source

pub fn resource_updated(uri: impl Into<String>) -> Self

Create a new ResourceUpdated notification

Source

pub fn resource_list_changed() -> Self

Create a new ResourceListChanged notification

Source

pub fn tool_list_changed() -> Self

Create a new ToolListChanged notification

Source

pub fn prompt_list_changed() -> Self

Create a new PromptListChanged notification

Source

pub fn elicitation_complete(elicitation_id: impl Into<String>) -> Self

Create a new ElicitationComplete notification

Source

pub fn task_status(params: TaskStatusNotificationParams) -> Self

Create a new TaskStatus notification

Trait Implementations§

Source§

impl Clone for ServerNotification

Source§

fn clone(&self) -> ServerNotification

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 ServerNotification

Source§

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

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

impl<'de> Deserialize<'de> for ServerNotification

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ServerNotification

Source§

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

Serialize this value into the given Serde serializer. Read more

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<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<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: 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: 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> 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 = 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,