Skip to main content

StandaloneEngine

Struct StandaloneEngine 

Source
pub struct StandaloneEngine;
Expand description

Standalone d-engine engine for independent deployment

Implementations§

Source§

impl StandaloneEngine

Source

pub async fn run( data_dir: impl AsRef<Path>, shutdown_rx: Receiver<()>, ) -> Result<(), Error>

Run server with an explicit data directory.

data_dir has highest priority and always overrides cluster.db_root_dir from CONFIG_PATH or RAFT__ environment variables. Other configuration (network, Raft timeouts, cluster topology) is still read from those sources if set.

The directory is created automatically if it does not exist. Blocks until shutdown signal is received.

§Arguments
  • data_dir - Path to the data directory
  • shutdown_rx - Shutdown signal receiver
§Example
let (shutdown_tx, shutdown_rx) = watch::channel(());
StandaloneEngine::run("./data/my-node", shutdown_rx).await?;
Source

pub async fn run_with( config_path: &str, shutdown_rx: Receiver<()>, ) -> Result<(), Error>

Run server with explicit configuration file.

Reads configuration from specified file path. Data directory is determined by config’s cluster.db_root_dir setting. Blocks until shutdown signal is received.

§Arguments
  • config_path - Path to configuration file
  • shutdown_rx - Shutdown signal receiver
§Example
let (shutdown_tx, shutdown_rx) = watch::channel(());
StandaloneEngine::run_with("config/node1.toml", shutdown_rx).await?;
Source

pub async fn run_custom<SE, SM>( storage_engine: Arc<SE>, state_machine: Arc<SM>, shutdown_rx: Receiver<()>, config_path: Option<&str>, ) -> Result<(), Error>
where SE: StorageEngine + Debug + 'static, SM: StateMachine + Debug + 'static,

Run server with custom storage engine and state machine.

Advanced API for users providing custom storage implementations. Blocks until shutdown signal is received.

§Arguments
  • config - Node configuration
  • storage_engine - Custom storage engine implementation
  • state_machine - Custom state machine implementation
  • shutdown_rx - Shutdown signal receiver
§Example
let storage = Arc::new(MyCustomStorage::new()?);
let sm = Arc::new(MyCustomStateMachine::new()?);

let (shutdown_tx, shutdown_rx) = watch::channel(());
StandaloneEngine::run_custom(storage, sm, shutdown_rx, Some("config.toml")).await?;

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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