Skip to main content

Fleet

Struct Fleet 

Source
pub struct Fleet<PlcId> { /* private fields */ }
Expand description

Multi-PLC pool built from actor-backed Client handles.

Implementations§

Source§

impl<PlcId> Fleet<PlcId>
where PlcId: Clone + Eq + Hash + Send + Sync + 'static,

Source

pub fn new() -> Self

Creates an empty fleet.

Source

pub async fn connect(&mut self, plc_id: PlcId, addr: &str) -> Result<Client>

Connects and adds one PLC by address.

Source

pub async fn connect_with_route( &mut self, plc_id: PlcId, addr: &str, route: RoutePath, ) -> Result<Client>

Connects and adds one routed PLC by address and route path.

Source

pub fn insert_client(&mut self, plc_id: PlcId, client: Client) -> Option<Client>

Inserts an existing actor client into the fleet.

Source

pub fn client(&self, plc_id: &PlcId) -> Option<Client>

Returns a cloneable client handle for one PLC.

Source

pub fn events(&self) -> Receiver<FleetEvent<PlcId>>

Subscribes to fleet-level connection events.

Source

pub async fn check_health(&self) -> HashMap<PlcId, Result<bool>>

Performs a health check against every PLC currently in the fleet.

Source

pub fn len(&self) -> usize

Returns the number of PLCs in the fleet.

Source

pub fn is_empty(&self) -> bool

Returns true when the fleet has no PLC clients.

Trait Implementations§

Source§

impl<PlcId: Debug> Debug for Fleet<PlcId>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<PlcId> Default for Fleet<PlcId>
where PlcId: Clone + Eq + Hash + Send + Sync + 'static,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<PlcId> Freeze for Fleet<PlcId>

§

impl<PlcId> !RefUnwindSafe for Fleet<PlcId>

§

impl<PlcId> Send for Fleet<PlcId>
where PlcId: Send,

§

impl<PlcId> Sync for Fleet<PlcId>
where PlcId: Sync + Send,

§

impl<PlcId> Unpin for Fleet<PlcId>
where PlcId: Unpin,

§

impl<PlcId> UnsafeUnpin for Fleet<PlcId>

§

impl<PlcId> !UnwindSafe for Fleet<PlcId>

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, 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.
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