Skip to main content

RenderOptions

Struct RenderOptions 

Source
#[non_exhaustive]
pub struct RenderOptions { pub input_label: String, pub max_traces_embedded: Option<usize>, pub pg_stat: Option<PgStatReport>, pub mysql_stat: Option<MySqlStatReport>, pub diff: Option<DiffReport>, pub daemon_url: Option<String>, }
Expand description

Options controlling HTML rendering.

#[non_exhaustive] for SemVer-minor field additions (0.9.5 added mysql_stat); struct literals (including functional record update) do not compile outside this crate, so external crates start from RenderOptions::default() and set the public fields one by one.

Fields (Non-exhaustive)§

This struct is marked as 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.
§input_label: String

Label shown in the top bar (filename, - for stdin, etc.).

§max_traces_embedded: Option<usize>

Explicit cap on embedded traces. When None, the sink trims to fit [DEFAULT_SIZE_TARGET_BYTES] using the top-waste fallback.

§pg_stat: Option<PgStatReport>

Optional pg_stat_statements report embedded alongside the analysis. When Some, the HTML dashboard exposes a pg_stat tab plus the Explain-to-pg_stat cross-navigation for matching SQL templates.

§mysql_stat: Option<MySqlStatReport>

Optional MySQL Performance Schema digest report embedded alongside the analysis. When Some, the HTML dashboard exposes a mysql_stat tab with the same ranking sub-switcher as pg_stat.

§diff: Option<DiffReport>

Optional diff against a baseline run embedded alongside the analysis. When Some, the HTML dashboard exposes a Diff tab with new/resolved findings, severity changes, and per-endpoint deltas.

§daemon_url: Option<String>

When Some, the generated HTML enables live mode: the in-page JavaScript connects to the daemon at this URL for ack/revoke interactions, fetches the daemon-side acks listing, and shows a connection-status indicator. Reveals the auth-key prompt modal on a 401 response. The daemon must have CORS configured (see [daemon.cors] in CONFIGURATION.md) and the document origin allowed.

When None, the HTML is purely static: no badge, no ack/revoke buttons, no acknowledgments panel, strict CSP with no connect-src directive.

The URL is expected to have been validated by the caller. The renderer trusts it as-is and concatenates it into the Content-Security-Policy connect-src directive. Validation rejects userinfo, paths, query strings and ASCII control characters via crates/sentinel-cli/src/ack.rs::validate_url. The browser-side handlers (auth-key prompt, ack/revoke modal, fetch retry) live in the live-mode IIFE block at the bottom of crates/sentinel-core/src/report/html_template.html.

Trait Implementations§

Source§

impl Clone for RenderOptions

Source§

fn clone(&self) -> RenderOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RenderOptions

Source§

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

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

impl Default for RenderOptions

Source§

fn default() -> RenderOptions

Returns the “default value” for a type. Read more

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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