Enum termwiz::escape::apc::KittyImageData

pub enum KittyImageData {
    Direct(String),
    File {
        path: String,
        data_size: Option<u32>,
        data_offset: Option<u32>,
    },
    TemporaryFile {
        path: String,
        data_size: Option<u32>,
        data_offset: Option<u32>,
    },
    SharedMem {
        name: String,
        data_size: Option<u32>,
        data_offset: Option<u32>,
    },
}

Variants

Direct(String)

The data bytes, baes64-encoded fragments. t=‘d’

File

Fields

path: String

data_size: Option<u32>

the amount of data to read. S=…

data_offset: Option<u32>

The offset at which to read. O=…

The path to a file containing the data. t=‘f’

TemporaryFile

Fields

path: String

data_size: Option<u32>

the amount of data to read. S=…

data_offset: Option<u32>

The offset at which to read. O=…

The path to a temporary file containing the data. If the path is in a known temporary location, it should be removed once the data has been read t=‘t’

SharedMem

Fields

name: String

data_size: Option<u32>

the amount of data to read. S=…

data_offset: Option<u32>

The offset at which to read. O=…

The name of a shared memory object. Can be opened via shm_open() and then should be removed via shm_unlink(). On Windows, OpenFileMapping(), MapViewOfFile(), UnmapViewOfFile() and CloseHandle() are used to access and release the data. t=‘s’

Implementations

impl KittyImageData

pub fn load_data(self) -> Result<Vec<u8>>

Take the image data bytes. This operation is not repeatable as some of the sources require removing the underlying file or shared memory object as part of the read operaiton.

Trait Implementations

impl Clone for KittyImageData

fn clone(&self) -> KittyImageData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KittyImageData

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

Formats the value using the given formatter.

impl PartialEq<KittyImageData> for KittyImageData

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for KittyImageData

impl StructuralEq for KittyImageData

impl StructuralPartialEq for KittyImageData