Skip to main content

Client

Struct Client 

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

A synchronous client for the beachcomber daemon.

Each method call creates a new socket connection. For multiple queries in sequence, use Session instead.

Implementations§

Source§

impl Client

Source

pub fn new() -> Self

Create a client with default configuration (100ms timeout, auto-start enabled).

Source

pub fn with_config(config: ClientConfig) -> Self

Create a client with custom configuration.

Source

pub fn get( &self, key: &str, path: Option<&str>, ) -> Result<CombResult, CombError>

Query a single key. Returns Hit with data, Miss, or an error.

Examples:

  • client.get("git.branch", Some("/path/to/repo")) — single field
  • client.get("git", Some("/path/to/repo")) — all fields
  • client.get("hostname.short", None) — global provider
Source

pub fn poke(&self, key: &str, path: Option<&str>) -> Result<(), CombError>

Trigger recomputation of a provider. Fire-and-forget.

Source

pub fn session(&self) -> Result<Session, CombError>

Open a persistent session for multiple queries on one connection.

Trait Implementations§

Source§

impl Default for Client

Source§

fn default() -> Self

Returns the “default value” for a type. 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, 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.