Struct Socket 

pub struct Socket { /* private fields */ }

A connection to a Unix socket, from cx.socket(path). It connects at once, passes each line it reads to on_line, and writes what write is given. A clone is cheap and shares the connection.

It closes when the context that opened it goes. When the other end closes it, connected turns false and it stays closed until reconnect: nothing retries on its own, so a socket that isn’t there never wakes the shell.

Implementations

impl Socket

pub fn connected(&self) -> ReadSignal<bool>

Whether it is connected: true from a connect that worked until the other end closes it, it breaks, or close.

pub fn on_line(self, on_line: impl Fn(&str) + 'static) -> Socket

Calls on_line with each line read, without its \n, decoded as UTF-8 with bad bytes replaced. What is left when the other end closes counts as a last line. A line over 1 MiB is dropped and logged.

It runs on the main thread. If it panics, that is logged with the socket’s path and where on_line was called, and it isn’t called again; the socket stays open.

pub fn write(&self, data: impl AsRef<[u8]>)

Sends data, all of it, as the other end takes it. While not connected it is dropped, and that is logged. If more than 4 MiB wait because the other end reads nothing, the socket is closed.

pub fn reconnect(&self)

Closes it and connects again, as after the other end restarted. Lines the old connection read and on_line hasn’t had yet are dropped.

pub fn close(&self)

Closes it. reconnect opens it again. Lines read and not yet passed on are dropped.

Trait Implementations

impl Clone for Socket

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.