Skip to main content

Server

Struct Server 

Source
pub struct Server { /* private fields */ }
Expand description

ICAP server.

Use Server::builder to construct and run an instance.

§Example

use icap_rs::{IcapResult, IncomingRequest, Method, Response, Server, ServiceOptions};

const ISTAG: &str = "scan-1.0";

#[tokio::main]
async fn main() -> IcapResult<()> {
    let server = Server::builder()
        .bind("127.0.0.1:1344")
        .route(
            "scan",
            [Method::ReqMod],
            |_req: IncomingRequest| async move {
                Ok(Response::no_content_with_istag(ISTAG)?)
            },
            Some(ServiceOptions::new().with_static_istag(ISTAG).with_preview(1024)),
        )
        .build()
        .await?;

    server.run().await
}

Implementations§

Source§

impl Server

Source

pub fn builder() -> ServerBuilder

Create a new ServerBuilder.

Source

pub fn local_addr(&self) -> Result<SocketAddr>

Local socket address the server is bound to.

Useful after binding to an ephemeral port (127.0.0.1:0).

Source

pub async fn run(self) -> IcapResult<()>

Run the accept loop until the process is killed.

This is a convenience wrapper around run_until with a pending() shutdown future, meaning the server runs indefinitely. Use run_until when you need graceful shutdown.

Source

pub async fn run_until<F>(self, shutdown: F) -> IcapResult<()>
where F: Future<Output = ()>,

Run the accept loop until shutdown resolves, then drain active connections.

When shutdown completes the server stops accepting new connections and signals all active keep-alive connections to close after their current in-flight request completes. Idle connections (waiting for the next request) are closed immediately. The method returns only after every active connection handler has finished.

§Example
use icap_rs::{IcapResult, Server};

#[tokio::main]
async fn main() -> IcapResult<()> {
    let server = Server::builder()
        .bind("127.0.0.1:1344")
        .build()
        .await?;

    // Shut down cleanly on Ctrl-C.
    server.run_until(async { tokio::signal::ctrl_c().await.ok(); }).await
}

Auto Trait Implementations§

§

impl !Freeze for Server

§

impl !RefUnwindSafe for Server

§

impl !UnwindSafe for Server

§

impl Send for Server

§

impl Sync for Server

§

impl Unpin for Server

§

impl UnsafeUnpin 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> From<T> for T

Source§

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