ServeConfig

Struct ServeConfig 

Source
pub struct ServeConfig {
Show 17 fields pub s3_uri: Option<String>, pub host: String, pub port: u16, pub s3_bucket: Option<String>, pub s3_endpoint: Option<String>, pub s3_region: String, pub auth_secret: Option<String>, pub auth_enabled: bool, pub cache_slides: usize, pub cache_blocks: usize, pub cache_tiles: usize, pub block_size: usize, pub jpeg_quality: u8, pub cache_max_age: u32, pub cors_origins: Option<Vec<String>>, pub verbose: bool, pub no_tracing: bool,
}
Expand description

Configuration for the serve command (tile server).

Fields§

§s3_uri: Option<String>

S3 bucket URI (e.g., s3://my-bucket) or just the bucket name. Alternative to –s3-bucket flag.

§host: String

Host address to bind the server to.

§port: u16

Port to listen on.

§s3_bucket: Option<String>

S3 bucket name containing the slide files. Can also be provided as a positional argument (s3://bucket).

§s3_endpoint: Option<String>

Custom S3 endpoint URL for S3-compatible services (MinIO, etc.).

If not specified, uses the default AWS S3 endpoint.

§s3_region: String

AWS region for S3.

§auth_secret: Option<String>

Secret key for HMAC-SHA256 signed URL authentication.

Required when authentication is enabled.

§auth_enabled: bool

Enable signed URL authentication.

When disabled (default), all tile requests are allowed without authentication. Enable for production deployments.

§cache_slides: usize

Maximum number of slides to keep in cache.

§cache_blocks: usize

Maximum number of blocks to cache per slide (256KB each).

§cache_tiles: usize

Maximum tile cache size in bytes (default: 100MB).

§block_size: usize

Block size in bytes for the block cache.

§jpeg_quality: u8

Default JPEG quality for tile encoding (1-100).

§cache_max_age: u32

HTTP Cache-Control max-age in seconds.

§cors_origins: Option<Vec<String>>

Allowed CORS origins (comma-separated).

If not specified, allows any origin.

§verbose: bool

Enable verbose logging (debug level).

§no_tracing: bool

Disable request tracing.

Implementations§

Source§

impl ServeConfig

Source

pub fn resolve_bucket(&self) -> Result<String, String>

Resolve the S3 bucket name from either the positional URI or –s3-bucket flag.

Source

pub fn validate(&self) -> Result<(), String>

Validate the configuration and return an error message if invalid.

Source

pub fn bind_address(&self) -> String

Get the server bind address as “host:port”.

Source

pub fn auth_secret_or_empty(&self) -> &str

Get the auth secret, returning empty string if not set.

Source

pub fn bucket(&self) -> String

Get the resolved bucket name, panicking if not set (call validate() first).

Trait Implementations§

Source§

impl Args for ServeConfig

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl Clone for ServeConfig

Source§

fn clone(&self) -> ServeConfig

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 ServeConfig

Source§

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

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

impl FromArgMatches for ServeConfig

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
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