Struct Response 

pub struct Response {
    pub control: Vec<(char, String)>,
    pub message: Option<String>,
}

Kitty graphics protocol APC (Application Programming Command) response.

See documentation.

Fields

control: Vec<(char, String)>

Control codes.

message: Option<String>

Message (“OK” or error).

Implementations

impl Response

pub fn get_code(&self, code: char) -> Option<&str>

Get the value of a code.

pub fn get_code_character(&self, code: char) -> Option<char>

Get the value of a code as a character.

pub fn get_code_integer(&self, code: char) -> Option<i32>

Get the value of a code as an integer.

pub fn is_ok(&self) -> bool

Whether the message is “OK”.

Examples found in repository

examples/response.rs (line 18)

fn main() {
    println!("Kitty supported: {}", Command::is_supported().expect("is_supported"));

    // This query should always return OK

    let response = Command::default()
        // Action = query
        .with_control('a', 'q')
        // Image ID
        .with_control('i', 1)
        .with_expect_response()
        .execute()
        .expect("execute")
        .expect("response");

    if response.is_ok() {
        println!("OK!");
    }

    // This command should always return an error

    let response = Command::default()
        // Image ID
        .with_control('i', 1)
        // Transmission medium = shared memory object
        .with_control('t', 's')
        .with_expect_response()
        .execute_with_payload(b"not a shared memory object")
        .expect("execute_with_payload")
        .expect("response");

    println!("Error: {}", response.message.expect("message"));
}

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

impl TryFrom<&[u8]> for Response

type Error = Error

The type returned in the event of a conversion error.

fn try_from(response: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.