Skip to main content

Node

Struct Node 

Source
pub struct Node<T: NodeImpl> { /* private fields */ }

Implementations§

Source§

impl<T: NodeImpl> Node<T>

Source

pub async fn from_config(config: T::Config) -> Result<Self>

Create a new node from a configuration.

This calls NodeImpl::init() and wraps the result in a Node.

§Errors

Returns an error if initialization fails.

Source

pub fn static_diagnostics(&self) -> Option<HashMap<String, String>>

The post-init snapshot of health_diagnostics() - see the field doc comment on static_diagnostics for why this is safe to read without locking node.

Source

pub async fn start(&self, ctx: Context) -> Result<()>

Start the node with the given context.

This orchestrates the full lifecycle:

  1. Run preflight() node-content checks
  2. Transition to Running state
  3. Call run()
  4. Call shutdown() on completion or error
  5. Transition to final state
§Errors

Returns an error if preflight() rejects the node’s config, or if the node fails during execution.

Source

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

Gracefully shutdown the node.

This calls shutdown() and transitions to Stopped state.

Source

pub async fn state(&self) -> NodeState

Get the current state of the node.

Source

pub async fn health_check(&self) -> HealthStatus

Perform a health check on the node.

Source

pub async fn is_healthy(&self) -> bool

Check if the node is healthy.

Trait Implementations§

Source§

impl<T: Clone + NodeImpl> Clone for Node<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Node<T>

§

impl<T> !UnwindSafe for Node<T>

§

impl<T> Freeze for Node<T>
where Arc<Mutex<T>>: Freeze,

§

impl<T> Send for Node<T>
where Arc<Mutex<T>>: Send,

§

impl<T> Sync for Node<T>
where Arc<Mutex<T>>: Sync,

§

impl<T> Unpin for Node<T>
where Arc<Mutex<T>>: Unpin,

§

impl<T> UnsafeUnpin for Node<T>
where Arc<Mutex<T>>: UnsafeUnpin,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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