Skip to main content

PageTemplate

Enum PageTemplate 

Source
pub enum PageTemplate {
    Default {
        title: Option<String>,
        body_text: Option<String>,
    },
    Tickbox {
        title: Option<String>,
        body_text: Option<String>,
        consent_text: Option<String>,
    },
    Custom(String),
}
Expand description

Controls what the user sees in the browser when __location__ is called.

§Variants at a glance

VariantDescription
PageTemplate::DefaultClean single-button page. Title and body text are customisable.
PageTemplate::TickboxSame, but requires a checkbox tick before the button activates. Title, body text, and consent label are customisable.
PageTemplate::CustomFully custom HTML. Place {} where the capture button should appear; the required JavaScript is injected automatically.

Variants§

§

Default

A clean, single-button consent page.

Both fields fall back to sensible built-in values when None.

§Example

// fully default
let t = PageTemplate::default();

// custom title only
let t = PageTemplate::Default {
    title:     Some("My App — Location".into()),
    body_text: None,
};

Fields

§title: Option<String>

Browser tab title and <h1> heading text. Falls back to "Location Access" when None.

§body_text: Option<String>

Descriptive paragraph shown below the heading. Falls back to a generic description when None.

§

Tickbox

Like Default but adds a checkbox the user must tick before the capture button becomes active.

§Example

let t = PageTemplate::Tickbox {
    title:        Some("Verify Location".into()),
    body_text:    None,
    consent_text: Some("I agree to share my location with this application.".into()),
};

Fields

§title: Option<String>

Browser tab title and <h1> heading text. Falls back to "Location Access" when None.

§body_text: Option<String>

Descriptive paragraph shown below the heading. Falls back to a generic description when None.

§consent_text: Option<String>

Text label shown next to the checkbox. Falls back to "I consent to sharing my location." when None.

§

Custom(String)

A fully custom HTML document.

Place exactly one {} in the string where the capture button should be injected. The required JavaScript (which POSTs to /location and /location-error) is injected automatically before </body>, so you do not need to write any geolocation JS yourself.

§Example

let html = r#"<!DOCTYPE html>
<html><body>
  <h1>Where are you?</h1>
  {}
  <div id="status"></div>
</body></html>"#;

let t = PageTemplate::Custom(html.into());

Trait Implementations§

Source§

impl Default for PageTemplate

Source§

fn default() -> Self

Returns PageTemplate::Default with both fields set to None (all text falls back to built-in defaults).

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

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