Skip to main content

InitializeParams

Struct InitializeParams 

Source
pub struct InitializeParams {
    pub channel: Uri,
    pub protocol_versions: Vec<String>,
    pub client_id: String,
    pub client_info: Option<Implementation>,
    pub initial_subscriptions: Option<Vec<Uri>>,
    pub locale: Option<String>,
    pub capabilities: Option<ClientCapabilities>,
}
Expand description

Establishes a new connection and negotiates the protocol version. This MUST be the first message sent by the client.

Fields§

§channel: Uri

Channel URI this command targets.

§protocol_versions: Vec<String>

Protocol versions the client is willing to speak, ordered from most preferred to least preferred. Each entry is a SemVer MAJOR.MINOR.PATCH string (e.g. "0.1.0").

The server selects one entry and returns it as InitializeResult.protocolVersion. If the server cannot speak any of the offered versions, it MUST return error code -32005 (UnsupportedProtocolVersion).

§client_id: String

Unique client identifier

§client_info: Option<Implementation>

Optional identity of the client implementation (name and version). Informational only — see {@link Implementation} for how it may and may not be used. Distinct from {@link InitializeParams.clientId | clientId}, which is an opaque per-connection identifier used for reconnection, not a human-readable implementation name.

§initial_subscriptions: Option<Vec<Uri>>

URIs to subscribe to during handshake

§locale: Option<String>

IETF BCP 47 language tag indicating the client’s preferred locale (e.g. "en-US", "ja"). The server SHOULD use this to localise user-facing strings such as confirmation option labels.

§capabilities: Option<ClientCapabilities>

Optional client capability declarations.

Servers SHOULD only advertise features whose corresponding client capability is set here. Absent means “not declared” — the server MUST assume the client does not support the feature.

Trait Implementations§

Source§

impl Clone for InitializeParams

Source§

fn clone(&self) -> InitializeParams

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 InitializeParams

Source§

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

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

impl<'de> Deserialize<'de> for InitializeParams

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 PartialEq for InitializeParams

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Serialize for InitializeParams

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

impl StructuralPartialEq for InitializeParams

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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