Skip to main content

ServerInfo

Struct ServerInfo 

Source
pub struct ServerInfo {
    pub version: String,
    pub host: String,
    pub port: u16,
    pub https: bool,
    pub docs_path: Option<String>,
    pub redoc_path: Option<String>,
    pub openapi_path: Option<String>,
}
Expand description

Server information for the banner.

Fields§

§version: String

Server version string.

§host: String

Host address.

§port: u16

Port number.

§https: bool

Whether HTTPS is enabled.

§docs_path: Option<String>

OpenAPI docs path (if enabled).

§redoc_path: Option<String>

ReDoc path (if enabled).

§openapi_path: Option<String>

OpenAPI JSON path.

Implementations§

Source§

impl ServerInfo

Source

pub fn new( version: impl Into<String>, host: impl Into<String>, port: u16, ) -> Self

Create a new server info with minimal configuration.

Source

pub fn https(self, enabled: bool) -> Self

Set whether HTTPS is enabled.

Source

pub fn docs_path(self, path: impl Into<String>) -> Self

Set the OpenAPI docs path.

Source

pub fn redoc_path(self, path: impl Into<String>) -> Self

Set the ReDoc path.

Source

pub fn openapi_path(self, path: impl Into<String>) -> Self

Set the OpenAPI JSON path.

Source

pub fn base_url(&self) -> String

Get the base URL.

Trait Implementations§

Source§

impl Clone for ServerInfo

Source§

fn clone(&self) -> ServerInfo

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 Debug for ServerInfo

Source§

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

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

impl Default for ServerInfo

Source§

fn default() -> Self

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

Auto Trait Implementations§

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.