Struct bonsaidb::server::cli::serve::Serve

source ·
pub struct Serve<B>where
    B: Backend,{
    pub listen_on: Option<SocketAddr>,
    pub reuse_address: Option<bool>,
    pub http_port: Option<SocketAddr>,
    pub https_port: Option<SocketAddr>,
    /* private fields */
}
Expand description

Execute the server

Fields§

§listen_on: Option<SocketAddr>

The socket address to listen for the BonsaiDb protocol. Defaults to a localhost IP address for UDP port 5645 (not an officially registered port).

§reuse_address: Option<bool>

If this option is specified, the SO_REUSEADDR flag will be set on the underlying socket. See BonsaiListenConfig::reuse_address for more information.

§http_port: Option<SocketAddr>

The bind port and address for HTTP traffic. Defaults to TCP port 80.

§https_port: Option<SocketAddr>

The bind port and address for HTTPS traffic. Defaults to TCP port 443.

Implementations§

source§

impl<B> Serve<B>where B: Backend,

source

pub async fn execute( &self, server: &CustomServer<B> ) -> impl Future<Output = Result<(), BackendError<<B as Backend>::Error>>>

Starts the server.

source

pub async fn execute_with<S>( &self, server: &CustomServer<B>, service: S ) -> impl Future<Output = Result<(), BackendError<<B as Backend>::Error>>>where S: TcpService,

Starts the server using service for websocket connections, if enabled.

Trait Implementations§

source§

impl<B> Args for Serve<B>where B: Backend,

source§

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments
source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self. Read more
source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self. Read more
source§

impl<B> Debug for Serve<B>where B: Debug + Backend,

source§

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

Formats the value using the given formatter. Read more
source§

impl<B> FromArgMatches for Serve<B>where B: Backend,

source§

fn from_arg_matches( __clap_arg_matches: &ArgMatches ) -> Result<Serve<B>, Error<RichFormatter>>

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Serve<B>, Error<RichFormatter>>

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error<RichFormatter>>

Assign values from ArgMatches to self.
source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error<RichFormatter>>

Assign values from ArgMatches to self.

Auto Trait Implementations§

§

impl<B> RefUnwindSafe for Serve<B>where B: RefUnwindSafe,

§

impl<B> Send for Serve<B>

§

impl<B> Sync for Serve<B>

§

impl<B> Unpin for Serve<B>where B: Unpin,

§

impl<B> UnwindSafe for Serve<B>where B: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

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