Skip to main content

Server

Struct Server 

Source
pub struct Server { /* private fields */ }
Expand description

Configured-but-not-running server.

Build one with ServerBuilder, then call Server::start to spawn the background tasks.

Implementations§

Source§

impl Server

Source

pub fn command_extension(&self) -> Option<&Arc<dyn CommandExtension>>

Borrow the crate::embed::CommandExtension this server was built with, if any.

Source

pub fn pool_name(&self) -> &str

The pool name configured in the YAML / builder.

Source

pub async fn start(self) -> Result<ServerHandle, EmbedError>

Spawn background tasks on the current tokio runtime and return a ServerHandle.

start is non-blocking. The returned handle is Clone + Send + Sync.

§In-process only

The embedded server in this stage is in-process only: the listen: and dyn_listen: sockets bind so that configured ports are reservable and post-bind reporting works, but cross-process clients connecting to those ports see open-then-immediate-close (with a runtime warning logged on each accept). The sanctioned way to drive an embedded Server from in-process code is ServerHandle::inject_request. Cross-process traffic is supported by the dynomited binary, which wires the proxy module directly. Wiring the embedded accept loop to the dispatcher is tracked as a follow-up; the contract is documented in docs/parity.md.

§Examples
use dynomite::embed::ServerBuilder;
use dynomite::conf::DataStore;
let server = ServerBuilder::new("dyn_o_mite")
    .listen("127.0.0.1:0".parse().unwrap())
    .dyn_listen("127.0.0.1:0".parse().unwrap())
    .data_store(DataStore::Redis)
    .servers(vec![dynomite::conf::ConfServer::parse("127.0.0.1:6379:1").unwrap()])
    .tokens_str("0")
    .enable_gossip(false)
    .build()
    .unwrap();
let handle = server.start().await.unwrap();
handle.shutdown().await.unwrap();
Source§

impl Server

Source

pub fn builder(pool_name: impl Into<String>) -> ServerBuilder

Convenience entry point.

§Examples
use dynomite::embed::Server;
let _b = Server::builder("dyn_o_mite");
Source

pub async fn start_with( builder: ServerBuilder, ) -> Result<ServerHandle, EmbedError>

One-shot “validate, build, and start” helper.

Equivalent to calling builder.build()?.start().await. The chained-call form remains available for embedders that want to inspect the Server before spawning tasks; this helper exists because most embedders only ever build then immediately start.

§Errors

Returns the same EmbedError variants that ServerBuilder::build and Server::start surface.

§Examples
use dynomite::embed::{Server, ServerBuilder};
use dynomite::conf::DataStore;
let builder = ServerBuilder::new("dyn_o_mite")
    .listen("127.0.0.1:0".parse().unwrap())
    .dyn_listen("127.0.0.1:0".parse().unwrap())
    .data_store(DataStore::Redis)
    .servers(vec![dynomite::conf::ConfServer::parse("127.0.0.1:6379:1").unwrap()])
    .tokens_str("0");
let handle = Server::start_with(builder).await.unwrap();
handle.shutdown().await.unwrap();

Trait Implementations§

Source§

impl Debug for Server

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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, 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
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,