Struct ListRootsRequest

pub struct ListRootsRequest {
    pub params: Option<ListRootsRequestParams>,
    /* 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": [
   "method"
 ],
 "properties": {
   "method": {
     "type": "string",
     "const": "roots/list"
   },
   "params": {
     "type": "object",
     "properties": {
       "_meta": {
         "type": "object",
         "properties": {
           "progressToken": {
             "description": "If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.",
             "$ref": "#/definitions/ProgressToken"
           }
         }
       }
     },
     "additionalProperties": {}
   }
 }
}

Fields

params: Option<ListRootsRequestParams>

Implementations

impl ListRootsRequest

pub fn new(params: Option<ListRootsRequestParams>) -> Self

pub fn method(&self) -> &String

pub fn method_name() -> String

Trait Implementations

impl Clone for ListRootsRequest

fn clone(&self) -> ListRootsRequest

Returns a copy 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 MessageFromServer

fn from(value: ListRootsRequest) -> Self

Converts to this type from the input type.

impl From<ListRootsRequest> for RequestFromServer

fn from(value: ListRootsRequest) -> Self

Converts to this type from the input type.

impl From<ListRootsRequest> for ServerRequest

fn from(value: ListRootsRequest) -> Self

Converts to this type from the input type.

impl FromMessage<ListRootsRequest> for ServerMessage

fn from_message( message: ListRootsRequest, request_id: Option<RequestId>, ) -> Result<Self, JsonrpcErrorError>

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.

impl ToMessage<ServerMessage> for ListRootsRequest

fn to_message( self, request_id: Option<RequestId>, ) -> Result<ServerMessage, JsonrpcErrorError>

impl TryFrom<RequestFromServer> for ListRootsRequest

type Error = JsonrpcErrorError

The type returned in the event of a conversion error.

fn try_from(value: RequestFromServer) -> Result<Self, Self::Error>

Performs the conversion.