Struct Options 

#[non_exhaustive]
pub struct Options { /* private fields */ }

What to check, and where the description’s paths start.

use roas_http_validator::Options;

let options = Options::new().base_path("/api/v1").reject_undescribed_query_parameters();

Implementations

impl Options

pub fn new() -> Self

Everything checked, base path taken from the Server Objects.

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

The prefix a request path carries before the description’s own paths begin, overriding whatever servers implies.

pub fn skip_body(self) -> Self

Leave the body alone. Useful in a middleware that would rather not buffer one, and in a client-side check of a request that has not been serialized yet.

pub fn decoder<F>(self, media_type: &str, decoder: F) -> Self

where F: Fn(&[u8], &str) -> Result<Value, String> + Send + Sync + 'static,

Read a media type this crate does not know how to read.

The built-in decoders cover JSON, application/x-www-form-urlencoded and text/*; anything else is reported as unchecked rather than guessed at. Register a decoder and its media type joins them — the bytes become a value, and the Schema Object judges it like any other.

This is how multipart/form-data and XML are meant to be handled: see crate::Decoder for why they are a hook rather than more built-ins.

Looked up the way a Media Type Object is — exact match, then a type/* range, then */* — and a registration takes precedence over the built-in for the same media type, so a caller who wants their own JSON reader can have one.

use roas_http_validator::Options;

let options = Options::new().decoder("text/csv", |bytes, _media_type| {
    let text = std::str::from_utf8(bytes).map_err(|error| error.to_string())?;
    Ok(serde_json::Value::Array(
        text.lines().map(|line| line.into()).collect(),
    ))
});

pub fn reject_undescribed_query_parameters(self) -> Self

Report a query parameter the operation does not describe.

Off by default: OpenAPI does not forbid undescribed query parameters, and plenty of real clients send tracking parameters that no description mentions. On, it catches the typo in ?limti=10 that would otherwise silently do nothing.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

Written out by hand because a decoder is a function, and a function has nothing useful to print. The media types it was registered for do.

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.