struct ACP::Protocol::ReadTextFileParams

• ACP::Protocol::ReadTextFileParams
• Struct
• Value
• Object

Overview

Request parameters for fs/read_text_file.

Included Modules

• JSON::Serializable

Defined in:

acp/protocol/client_methods.cr

Constructors

• .new(session_id : String, path : String, line : Int32 | Nil = nil, limit : Int32 | Nil = nil, meta : Hash(String, JSON::Any) | Nil = nil)
• .new(pull : JSON::PullParser)

Instance Method Summary

• #limit : Int32 | Nil

  Optional maximum number of lines to read.

• #limit=(limit : Int32 | Nil)

  Optional maximum number of lines to read.

• #line : Int32 | Nil

  Optional line number to start reading from (1-based).

• #line=(line : Int32 | Nil)

  Optional line number to start reading from (1-based).

• #meta : Hash(String, JSON::Any) | Nil

  Extension metadata.

• #meta=(meta : Hash(String, JSON::Any) | Nil)

  Extension metadata.

• #path : String

  Absolute path to the file to read (required).

• #path=(path : String)

  Absolute path to the file to read (required).

• #session_id : String

  The session ID for this request (required).

• #session_id=(session_id : String)

  The session ID for this request (required).

Constructor Detail

Instance Method Detail