Skip to main content

Server

Struct Server 

Source
pub struct Server(/* private fields */);
Expand description

The primary server structure that provides a thread-safe interface to the server’s state.

This struct acts as a public-facing wrapper around an Arc<RwLock<ServerData>>. It allows multiple parts of the application to safely share and modify the server’s configuration and state across different threads and asynchronous tasks.

Implementations§

Source§

impl Server

Implementation of methods for the Server structure.

Source

pub fn new() -> Self

Creates a new Server instance with default settings.

§Returns
  • Self - A new Server instance.
Source

pub async fn server_config(&self, config: ServerConfig) -> &Self

Sets the server configuration.

§Arguments
  • ServerConfig - The server configuration.
§Returns
  • &Self - Reference to self for method chaining.
Source

pub fn get_bind_addr<H>(host: H, port: u16) -> String
where H: AsRef<str>,

Constructs a bind address string from host and port。

§Arguments
  • AsRef<str> - Type that can be referenced as a string slice.
  • u16 - The port number.
§Returns
  • String - The formatted bind address.
Source

pub async fn hook<H>(&self) -> &Self
where H: ServerHook,

Adds a typed hook to the server’s hook list.

§Arguments
  • ServerHook - The hook type that implements ServerHook.
§Returns
  • &Self - Reference to self for method chaining.
Source

pub async fn task_panic<H>(&self) -> &Self
where H: ServerHook,

Adds a panic handler to the server’s task panic handler list.

§Arguments
  • ServerHook - The handler type that implements ServerHook.
§Returns
  • &Self - Reference to self for method chaining.
Source

pub async fn read_error<H>(&self) -> &Self
where H: ServerHook,

Adds an error handler to the server’s error handler list.

§Arguments
  • ServerHook - The handler type that implements ServerHook.
§Returns
  • &Self - Reference to self for method chaining.
Source

pub async fn run(&self) -> Result<ServerControlHook, ServerError>

Starts the server and begins accepting connections.

§Returns
  • Result<ServerControlHook, ServerError> - The control hook on success, or an error on failure.

Trait Implementations§

Source§

impl Clone for Server

Source§

fn clone(&self) -> Server

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for Server

Provides a default implementation for Server.

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Server

§

impl !RefUnwindSafe for Server

§

impl Send for Server

§

impl Sync for Server

§

impl Unpin for Server

§

impl !UnwindSafe for Server

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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