Struct ReadTextFileRequest 

#[non_exhaustive]
pub struct ReadTextFileRequest {
    pub session_id: SessionId,
    pub path: PathBuf,
    pub line: Option<u32>,
    pub limit: Option<u32>,
    pub meta: Option<Map<String, Value>>,
}

Request to read content from a text file.

Only available if the client supports the fs.readTextFile capability.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

session_id: SessionId

The session ID for this request.

path: PathBuf

Absolute path to the file to read.

line: Option<u32>

Line number to start reading from (1-based).

limit: Option<u32>

Maximum number of lines to read.

meta: Option<Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl ReadTextFileRequest

pub fn new( session_id: impl Into<SessionId>, path: impl Into<PathBuf>, ) -> ReadTextFileRequest

Builds ReadTextFileRequest with the required request fields set; optional fields start unset or empty.

pub fn line(self, line: impl IntoOption<u32>) -> ReadTextFileRequest

Line number to start reading from (1-based).

pub fn limit(self, limit: impl IntoOption<u32>) -> ReadTextFileRequest

Maximum number of lines to read.

pub fn meta( self, meta: impl IntoOption<Map<String, Value>>, ) -> ReadTextFileRequest

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations

impl Clone for ReadTextFileRequest

fn clone(&self) -> ReadTextFileRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadTextFileRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReadTextFileRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReadTextFileRequest

impl JsonRpcMessage for ReadTextFileRequest

fn matches_method(method: &str) -> bool

Check if this message type matches the given method name.

fn method(&self) -> &str

The method name for the message.

fn to_untyped_message(&self) -> Result<UntypedMessage, Error>

Convert this message into an untyped message.

fn parse_message(method: &str, params: &impl Serialize) -> Result<Self, Error>

Parse this type from a method name and parameters.

impl JsonRpcRequest for ReadTextFileRequest

type Response = ReadTextFileResponse

The type of data expected in response.

impl JsonSchema for ReadTextFileRequest

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ReadTextFileRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ReadTextFileRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReadTextFileRequest