Struct NodeApi

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

Implementations§

Source§

impl NodeApi

Source

pub fn new(node_name: &str, node_version: &str) -> Self

Creates a new instance of NodeApi.

§Arguments
  • node_name - A string slice that holds the name of the node.
  • node_version - A string slice that holds the version of the node.
§Returns

A new instance of NodeApi with the specified node name and version, and default health status set to Healthy and an empty list of services.

Source

pub fn update_health(&mut self, new_health: NodeHealth)

Updates the health status of the node.

§Arguments
  • new_health - The new health status to be set for the node.
Source

pub fn register_service( &mut self, id: &str, name: &str, description: &str, status: ServiceStatus, )

Registers a new service with the node.

§Arguments
  • id - A string slice that holds the unique identifier of the service.
  • name - A string slice that holds the name of the service.
  • description - A string slice that holds the description of the service.
  • status - The status of the service, represented by the ServiceStatus enum.
Source

pub fn update_service_status( &mut self, service_id: &str, status: ServiceStatus, ) -> Result<(), NodeApiError>

Updates the status of a registered service.

§Arguments
  • service_id - A string slice that holds the unique identifier of the service.
  • status - The new status to be set for the service, represented by the ServiceStatus enum.
§Returns

A Result which is Ok(()) if the service status was updated successfully, or an Err with a message if the service with the specified id was not found.

Source

pub fn deregister_service( &mut self, service_id: &str, ) -> Result<(), NodeApiError>

Deregisters a service from the node.

§Arguments
  • service_id - A string slice that holds the unique identifier of the service.
§Returns

A Result which is Ok(()) if the service was deregistered successfully, or an Err with a message if the service with the specified id was not found.

Trait Implementations§

Source§

impl Clone for NodeApi

Source§

fn clone(&self) -> NodeApi

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'de> Deserialize<'de> for NodeApi

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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> CloneToUninit for T
where T: Clone,

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. 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> 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 = 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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,