Struct TevClient 

pub struct TevClient { /* private fields */ }

A connection to a Tev instance. Constructed using TevClient::wrap, TevClient::spawn or TevClient::spawn_path_default. Use TevClient::send to send commands.

Implementations

impl TevClient

pub fn wrap(socket: TcpStream) -> Self

Create a TevClient from an existing TcpStream that’s connected to tev. If tev may not be running yet use TevClient::spawn or TevClient::spawn_path_default instead.

For example, if tev is already running on the default hostname:

let mut client = TevClient::wrap(TcpStream::connect("127.0.0.1:14158")?);

pub fn spawn_path_default() -> Result<TevClient, TevError>

Create a new TevClient by spawning tev assuming it is in PATH with the default hostname.

pub fn spawn(command: Command) -> Result<TevClient, TevError>

Crate a TevClient from a command that spawns tev. If tev is in PATH and the default hostname should be used use TevClient::spawn_path_default instead.

let mut command = Command::new("path/to/tev");
command.arg("--hostname=127.0.0.1:14159");
let mut client = TevClient::spawn(command)?;

pub fn send(&mut self, packet: impl TevPacket) -> Result<()>

Send a command to tev. A command is any struct in this crate that implements [TevPacket].

Example

client.send(PacketCloseImage { image_name: "test.exf" })?;

Trait Implementations

impl Debug for TevClient

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

Formats the value using the given formatter.