Struct fuel_core::service::FuelService

pub struct FuelService {
    pub shared: SharedState,
    pub bound_address: SocketAddr,
    /* private fields */
}

Fields

shared: SharedState

The shared state of the service

bound_address: SocketAddr

The address bound by the system for serving the API

Implementations

impl FuelService

pub fn new(database: Database, config: Config) -> Result<Self>

Creates a FuelService instance from service config

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

Creates and starts fuel node instance from service config

pub async fn from_database(database: Database, config: Config) -> Result<Self>

Creates and starts fuel node instance from service config and a pre-existing database

Trait Implementations

impl Service for FuelService

fn start(&self) -> Result<()>

Send a start signal to the service without waiting for it to start. Returns an error if the service was already started.

fn start_and_await<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<State>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Send a start signal to the service and wait for it to start up. Returns an error if the service was already started.

fn await_start_or_stop<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<State>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Wait for service to start or stop (without sending any signal).

fn stop(&self) -> bool

Send a stop signal to the service without waiting for it to shutdown. Returns false if the service was already stopped, true if it is running.

fn stop_and_await<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<State>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Send stop signal to service and wait for it to shutdown.

fn await_stop<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<State>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Wait for service to stop (without sending a stop signal).

fn state(&self) -> State

The current state of the service (i.e. Started, Stopped, etc..)

fn state_watcher(&self) -> StateWatcher

Returns the state watcher of the service.