Struct WindowBind 

pub struct WindowBind {
    pub into: BindTarget,
    pub name: String,
    pub path: Option<String>,
    pub value_type: BindValueType,
    pub template: String,
    pub format: BindFormat,
}

Injects a rendered window boundary into the outgoing request — the window analogue of ReplicationBind. Reuses the same BindTarget placement and BindFormat formatting.

Fields

into: BindTarget

Where to place the rendered boundary (query param / header / body field / path placeholder).

name: String

The parameter / header / body-field / path-placeholder name. Optional only for into: body with a path.

path: Option<String>

into: body only: an RFC 6901 JSON Pointer into the configured body (/dateRanges/0/startDate) instead of a top-level name (#748).

value_type: BindValueType

JSON type written by a body bind: string (default) or number.

template: String

Template rendered with WINDOW_PLACEHOLDER (${window}) replaced by the formatted boundary. Defaults to the bare ${window}; set e.g. "gte|${window}" or "[${window} TO *]". ${window.start} and ${window.end} render the window’s start and (granularity-adjusted) end in any bind, so one bind can carry both bounds ("segments.date BETWEEN '${window.start}' AND '${window.end}'"). The rendered value is not escaped for any query language.

format: BindFormat

How to format the boundary before substitution.

Implementations

impl WindowBind

pub fn is_unset(&self) -> bool

Whether this bind is the unset default (an omitted WindowSpec::upper).

pub fn validate(&self, side: &str) -> Result<(), FaucetError>

Validate the bind at config-load time. side names the field for errors ("lower" / "upper").

pub fn render(&self, boundary: DateTime<Utc>) -> String

Render the bind for a concrete boundary instant.

pub fn render_window( &self, own: DateTime<Utc>, start: DateTime<Utc>, end: DateTime<Utc>, ) -> String

Render the bind for a window: ${window} becomes own, ${window.start} the window start and ${window.end} the rendered end.

Trait Implementations

impl Clone for WindowBind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowBind

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

Formats the value using the given formatter.

impl Default for WindowBind

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WindowBind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WindowBind

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for WindowBind

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for WindowBind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WindowBind