Struct bonsaidb_server::cli::serve::Serve

source · [−]

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

Expand description

Execute the server

Fields

listen_on: Option<u16>

The UDP port for the BonsaiDb protocol. Defaults to UDP port 5645 (not an officially registered port).

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: Backend> Serve

source

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

Starts the server.

source

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

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

Trait Implementations

source

impl<B: Backend> Args for Serve

source

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

Append to Command so it can instantiate Self. Read more

source

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

Append to Command so it can update self. Read more

source

impl<B: Debug + Backend> Debug for Serve

source

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

Formats the value using the given formatter. Read more

source

impl<B: Backend> FromArgMatches for Serve

source

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

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>

Assign values from ArgMatches to self.

Auto Trait Implementations

impl RefUnwindSafe for Serve where
B: RefUnwindSafe,

impl Send for Serve

impl Sync for Serve

impl Unpin for Serve where
B: Unpin,

impl UnwindSafe for Serve where
B: UnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub 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 for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

pub 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

Struct bonsaidb_server::cli::serve::Serve

Fields

Implementations

impl<B: Backend> Serve<B>

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

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

Trait Implementations

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

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

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

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

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

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

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

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

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

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

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

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

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

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

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

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,