Struct ListRootsRequest 

pub struct ListRootsRequest {
    pub id: RequestId,
    pub params: Option<RequestParams>,
    /* private fields */
}

Sent from the server to request a list of root URIs from the client. Roots allow servers to ask for specific directories or files to operate on. A common example for roots is providing a set of repositories or directories a server should operate on. This request is typically used when the server needs to understand the file system structure or access specific locations that the client has permission to read from.

JSON schema

{
 "description": "Sent from the server to request a list of root URIs from the client. Roots allow\nservers to ask for specific directories or files to operate on. A common example\nfor roots is providing a set of repositories or directories a server should operate\non.\n\nThis request is typically used when the server needs to understand the file system\nstructure or access specific locations that the client has permission to read from.",
 "type": "object",
 "required": [
   "id",
   "jsonrpc",
   "method"
 ],
 "properties": {
   "id": {
     "$ref": "#/$defs/RequestId"
   },
   "jsonrpc": {
     "type": "string",
     "const": "2.0"
   },
   "method": {
     "type": "string",
     "const": "roots/list"
   },
   "params": {
     "$ref": "#/$defs/RequestParams"
   }
 }
}

Fields

id: RequestId

params: Option<RequestParams>

Implementations

impl ListRootsRequest

pub fn new(id: RequestId, params: Option<RequestParams>) -> Self

pub fn jsonrpc(&self) -> &String

pub fn method(&self) -> &String

pub fn method_value() -> &'static str

returns “roots/list”

pub fn method_name() -> &'static str

👎Deprecated since 0.8.0: Use method_value() instead.

Trait Implementations

impl Clone for ListRootsRequest

fn clone(&self) -> ListRootsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListRootsRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ListRootsRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ListRootsRequest> for ServerRequest

fn from(value: ListRootsRequest) -> Self

Converts to this type from the input type.

impl Serialize for ListRootsRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.