Enum bonsaidb::server::NoBackend

pub enum NoBackend {}

A Backend with no custom functionality.

Trait Implementations

impl Backend for NoBackend

type CustomApi = ()

The custom API definition. If you do not wish to have an API, () may be provided.

type CustomApiDispatcher = NoDispatcher<NoBackend>

The type that implements the Dispatcher trait.

type ClientData = ()

The type of data that can be stored in ConnectedClient::set_client_data. This allows state to be stored associated with each connected client.

fn initialize<'life0, 'async_trait>(
    server: &'life0 CustomServer<Self>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Invoked once upon the server starting up.

fn client_connected<'life0, 'life1, 'async_trait>(
    client: &'life0 ConnectedClient<Self>,
    server: &'life1 CustomServer<Self>
) -> Pin<Box<dyn Future<Output = ConnectionHandling> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

A client disconnected from the server. This is invoked before authentication has been performed.

fn client_disconnected<'life0, 'async_trait>(
    client: ConnectedClient<Self>,
    server: &'life0 CustomServer<Self>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

A client disconnected from the server.

fn client_authenticated<'life0, 'async_trait>(
    client: ConnectedClient<Self>,
    server: &'life0 CustomServer<Self>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

A client successfully authenticated.

impl CommandLine for NoBackend

type Backend = Self

The Backend for this command line.

type Subcommand = Self

The Subcommand which is embedded next to the built-in BonsaiDb commands.

fn configuration<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<ServerConfiguration>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the server configuration to use when initializing a local server.

fn execute<'life0, 'async_trait>(
    &'life0 mut self,
    _command: Self::Subcommand,
    _connection: AnyServerConnection<Self>
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Execute the command on connection.

fn run<'async_trait>(
    self
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Runs the command-line interface using command-line arguments from the environment.

fn run_from<'async_trait, I, T>(
    self,
    itr: I
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    I: IntoIterator<Item = T> + Send,
    T: Into<OsString> + Clone + Send,
    I: 'async_trait,
    T: 'async_trait,
    Self: 'async_trait, 

Runs the command-line interface using the specified list of arguments.

fn open_server<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<CustomServer<Self::Backend>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns a new server initialized based on the same configuration used for CommandLine.

impl Debug for NoBackend

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

Formats the value using the given formatter.

impl FromArgMatches for NoBackend

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

Instantiate Self from ArgMatches, parsing the arguments as needed.

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

Assign values from ArgMatches to self.

impl Subcommand for NoBackend

pub fn augment_subcommands(__clap_app: App<'b>) -> App<'b>

Append to App so it can instantiate Self.

pub fn augment_subcommands_for_update(__clap_app: App<'b>) -> App<'b>

Append to App so it can update self.

pub fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand