Struct bonsaidb_server::cli::serve::Serve

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

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

impl<B: Backend> Serve<B>

pub async fn execute( &self, server: &CustomServer<B> ) -> Result<(), BackendError<B::Error>>

Starts the server.

pub async fn execute_with<S: TcpService>( &self, server: &CustomServer<B>, service: S ) -> Result<(), BackendError<B::Error>>

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

Trait Implementations

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

fn group_id() -> Option<Id>

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

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

Append to [Command] so it can instantiate Self.

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

Append to [Command] so it can update self.

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

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

Formats the value using the given formatter.

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

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

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

Assign values from ArgMatches to self.

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

Assign values from ArgMatches to self.