Struct spaceapi_server::SpaceapiServerBuilder

pub struct SpaceapiServerBuilder { /* fields omitted */ }

Builder to create a new SpaceapiServer instance.

Methods

impl SpaceapiServerBuilder

pub fn new(status: Status) -> SpaceapiServerBuilder

Create a new builder instance based on the provided static status data.

pub fn redis_connection_info<R: IntoConnectionInfo>(
    self,
    redis_connection_info: R
) -> Self

Specify a Redis connection string.

This can be any object that implements redis::IntoConnectionInfo, e.g. a connection string:

...
.redis_connection_info("redis://127.0.0.1/")
...

pub fn redis_pool(self, redis_pool: Pool<RedisConnectionManager>) -> Self

Use this as an alternative to redis_connection_info if you want to initialize the Redis connection pool yourself, to have full control over the connection parameters.

See examples/with_custom_redis_pool.rs for a real example.

pub fn add_status_modifier<M: StatusModifier + 'static>(
    self,
    modifier: M
) -> Self

Add a status modifier, that modifies the status dynamically per request.

This can be an instance of modifiers::StateFromPeopleNowPresent, or your own implementation that uses the dynamic sensor data and/or external data.

pub fn add_sensor<T: SensorTemplate + 'static>(
    self,
    template: T,
    data_key: String
) -> Self

Add a new sensor.

The first argument is a api::SensorTemplate instance containing all static data. The second argument specifies how to get the actual sensor value from Redis.

pub fn build(self) -> Result<SpaceapiServer, SpaceapiServerError>

Build a server instance.

This can fail if not all required data has been provided.