Struct spirit_hyper::HyperServer

#[non_exhaustive]pub struct HyperServer<Transport> {
    pub transport: Transport,
    pub hyper_cfg: HyperCfg,
}

A Fragment for hyper servers.

This is a wrapper around a Transport Fragment. It takes something that accepts connections ‒ like TcpListen and adds configuration specific for a HTTP server.

The Fragment produces hyper Builder. The BuildServer transformation can be used to make it into a Server and install it into a tokio runtime.

See also the HttpServer type alias.

Configuration options

In addition to options already provided by the Transport, these options are added:

• http1-keepalive: boolean, default true.
• http-mode: One of "both", "http1-only" or "http2-only". Defaults to "both".

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct {{ .. }} syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

transport: Transport

The inner transport.

This is accessible by the user in case it contains something of use to the Transformations.

hyper_cfg: HyperCfg

Configuration of Hyper.

The HTTP configuration is inside this.

Trait Implementations

impl<Transport: Clone> Clone for HyperServer<Transport>

fn clone(&self) -> HyperServer<Transport>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Transport: Comparable> Comparable<HyperServer<Transport>> for HyperServer<Transport>

fn compare(&self, other: &Self) -> Comparison

Compares two fragments.

impl<Transport: Debug> Debug for HyperServer<Transport>

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

Formats the value using the given formatter.

impl<Transport: Default> Default for HyperServer<Transport>

fn default() -> HyperServer<Transport>

Returns the “default value” for a type.

impl<'de, Transport> Deserialize<'de> for HyperServer<Transport> where
    Transport: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<Transport: Eq> Eq for HyperServer<Transport>

impl<Transport> Fragment for HyperServer<Transport> where
    Transport: Fragment + Debug + Clone + Comparable, 

type Driver = CacheSimilar<Self>

The default driver to be used by the fragment.

type Installer = ()

The default installer to be used unless a transformation or the user doesn’t provide one.

type Seed = Transport::Seed

The intermediate product if the fragment supports two-stage creation of Resources. If not, it can be set to ().

type Resource = Builder<Acceptor<Transport::Resource>>

The actual product this Fragment creates.

fn make_seed(&self, name: &'static str) -> Result<Self::Seed, AnyError>

Runs the first stage of creation.

fn make_resource(
    &self,
    seed: &mut Self::Seed,
    name: &'static str
) -> Result<Self::Resource, AnyError>

Runs the second stage of creation.

pub const RUN_BEFORE_CONFIG: bool

Configuration if the pipeline should be run once even before the config is loaded.

pub fn create(
    &self,
    name: &'static str
) -> Result<Self::Resource, Box<dyn Error + 'static + Sync + Send, Global>>

Runs both stages of creation at once.

pub fn init<B>(
    builder: B,
    &'static str
) -> Result<B, Box<dyn Error + 'static + Sync + Send, Global>> where
    B: Extensible<Ok = B>,
    <B as Extensible>::Config: DeserializeOwned,
    <B as Extensible>::Config: Send,
    <B as Extensible>::Config: Sync,
    <B as Extensible>::Config: 'static,
    <B as Extensible>::Opts: StructOpt,
    <B as Extensible>::Opts: Send,
    <B as Extensible>::Opts: Sync,
    <B as Extensible>::Opts: 'static, 

An initialization routine.

impl<Transport: Hash> Hash for HyperServer<Transport>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<Transport: Ord> Ord for HyperServer<Transport>

fn cmp(&self, other: &HyperServer<Transport>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<Transport: PartialEq> PartialEq<HyperServer<Transport>> for HyperServer<Transport>

fn eq(&self, other: &HyperServer<Transport>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HyperServer<Transport>) -> bool

This method tests for !=.

impl<Transport: PartialOrd> PartialOrd<HyperServer<Transport>> for HyperServer<Transport>

fn partial_cmp(&self, other: &HyperServer<Transport>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Transport> Serialize for HyperServer<Transport> where
    Transport: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<Transport> Stackable for HyperServer<Transport> where
    Transport: Stackable, 

impl<Transport> StructDoc for HyperServer<Transport> where
    Transport: StructDoc, 

fn document() -> Documentation

Returns the documentation for the type.

impl<Transport> StructuralEq for HyperServer<Transport>

impl<Transport> StructuralPartialEq for HyperServer<Transport>

impl<Tr, Inst, BS> Transformation<Builder<Acceptor<<Tr as Fragment>::Resource>, Exec>, Inst, HyperServer<Tr>> for BuildServer<BS> where
    Tr: Fragment + Clone + Send + 'static,
    Tr::Resource: Send,
    BS: ServerBuilder<Tr> + Clone + Send + 'static,
    BS::OutputFut: Future<Output = Result<(), HyperError>>, 

type OutputResource = Activate<BS::OutputFut>

The type of resource after the transformation.

type OutputInstaller = FutureInstaller

The type of installer after the transformation.

fn installer(&mut self, _ii: Inst, _name: &'static str) -> Self::OutputInstaller

Creates the installer.

fn transform(
    &mut self,
    builder: Builder<Acceptor<Tr::Resource>>,
    cfg: &HyperServer<Tr>,
    name: &'static str
) -> Result<Self::OutputResource, AnyError>

Transforms one instance of the resource.