Enum CoreRequest

pub enum CoreRequest {
    Edit(EditCommand<EditRequest>),
    NewView {
        file_path: Option<String>,
    },
    GetConfig {
        view_id: ViewId,
    },
    DebugGetContents {
        view_id: ViewId,
    },
}

The requests which make up the base of the protocol.

All requests expect a response.

Examples

The new_view command:

extern crate serde_json;
use crate::xi_core::rpc::CoreRequest;

let json = r#"{
    "method": "new_view",
    "params": { "file_path": "~/my_very_fun_file.rs" }
    }"#;

let cmd: CoreRequest = serde_json::from_str(&json).unwrap();
match cmd {
    CoreRequest::NewView { .. } => (), // expected
    other => panic!("Unexpected variant {:?}", other),
}

Variants

Edit(EditCommand<EditRequest>)

The ‘edit’ namespace, for view-specific requests.

NewView

Tells xi-core to create a new view. If the file_path argument is present, xi-core should attempt to open the file at that location.

Returns the view identifier that should be used to interact with the newly created view.

Fields

file_path: Option<String>

GetConfig

Returns the current collated config object for the given view.

Fields

view_id: ViewId

DebugGetContents

Returns the contents of the buffer for a given ViewId. In the future this might also be used to return structured data (such as for printing).

Fields

view_id: ViewId

Trait Implementations

impl Debug for CoreRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CoreRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CoreRequest

fn eq(&self, other: &CoreRequest) -> 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 CoreRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CoreRequest