Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }

Implementations§

Source§

impl Client

Source

pub fn connect_any_version(paths: &Paths) -> Result<Option<Client>>

Connects to whatever daemon answers, of any version; None when nothing does.

Source

pub fn connect_or_start(paths: &Paths) -> Result<Client>

Connects, starting this binary as the daemon when none answers, and replacing a daemon of an older version or another protocol; a newer daemon is an error, so an old window never kills its upgrade.

Source

pub fn connect_or_start_with( paths: &Paths, exe: &Path, version: &str, ) -> Result<Client>

Source

pub fn is_closed(&self) -> bool

True once the daemon hung up; a holder should connect again.

Source

pub fn request(&self, account: &str, command: Command) -> Result<Event>

Sends and waits for the reply, up to 120 s unless reply_timeout says the command may take longer.

Source

pub fn send(&self, account: &str, command: Command) -> bool

Sends without waiting; a refusal arrives as Event::CommandFailed on the subscription.

Source

pub fn subscribe(&self) -> Result<Receiver<Event>>

Every broadcast event from now on, plus refusals of send. Call once.

Source

pub fn subscribe_waking( &self, wake: impl Fn() + Send + 'static, ) -> Result<Receiver<Event>>

As subscribe, calling wake after each event and once the daemon hung up, so a window can repaint.

Source

pub fn status(&self) -> Result<Status>

Source

pub fn shutdown(&self) -> Result<()>

Source

pub fn stop_and_wait(&self, paths: &Paths) -> Result<u32>

Stops the daemon and waits for its socket to go; returns the pid it had.

Trait Implementations§

Source§

impl Drop for Client

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more