Skip to main content

AppServer

Struct AppServer 

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

An application’s server.

Implementations§

Source§

impl AppServer

Source

pub fn new(ctx: &'static AppContext, version: &'static str) -> AppServer

A server for ctx’s application, reporting version in its handshake.

Source

pub fn app_name(&self) -> &'static str

The application this server serves, as its AppContext names it.

FrameworkCommand reads it to build the CLI’s endpoint, so an application never passes its own name twice.

Source

pub fn endpoint(self, endpoint: Endpoint) -> AppServer

Listen somewhere other than the application’s default endpoint. Used by tests.

Source

pub fn app_api(self, version: u32) -> AppServer

Report version as the application’s own API version in the handshake: the major of the application’s API crate, which carries the methods it adds with extend. A client that calls those methods names the version it expects, and the handshake refuses a server that speaks another.

Source

pub fn config(self, config: ServerConfig) -> AppServer

Use config rather than reading <config dir>/server.toml: for fixtures.

Source

pub fn selection_file(self, path: PathBuf) -> AppServer

Keep the selected workspace (workspace.toml) at path rather than in the application’s config directory: for fixtures that run several hosts in one process.

Source

pub fn sync(self, runtime: Arc<SyncRuntime>) -> AppServer

Serve sync.enable, sync.disable, sync.map and sync.status, and keep a replica of the workspace in step with its files while it is synced.

Without this the server has no sync at all: an application that does not call it never talks to the bridge. The runtime is built by the caller because it needs the bridge connection, which is the caller’s to open and to close.

Source

pub fn status_rows( self, rows: Arc<dyn Fn() -> Vec<StatusRow> + Send + Sync>, ) -> AppServer

The application’s own rows for the status report: shown after the framework’s running / version / pid / managed_by lines.

The closure is called once per report, so an application’s rows may read live state; the CLI’s status and the IPC server.info method render the same call’s output.

Source

pub fn service_spec(&self) -> ServiceSpec

What this application’s service is: the arguments a service manager starts it with.

["serve"]: a service manager starts the executable directly, and the executable’s bare invocation is serve — the subcommand-less default of FrameworkCommand::Serve. A CLI that wants its service installed hands this to ServiceCommand.

Source

pub fn extend( self, f: impl FnOnce(Router) -> Router + Send + 'static, ) -> AppServer

Add the application’s own methods.

Source

pub fn host(&self) -> &Arc<WorkspaceHost> ⓘ

The workspace this server has open. An application’s own handlers use it to reach the workspace the same way the framework’s do: WorkspaceHost::backend.

Source

pub async fn run(self) -> Result<()>

Listen until told to stop, or until a signal arrives.

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<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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Fruit for T
where T: Send + Downcast,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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