Skip to main content

AppState

Struct AppState 

Source
pub struct AppState {
    pub project_root: PathBuf,
    pub out_dir: PathBuf,
    pub docs_dir: PathBuf,
    pub base: String,
    pub port: u16,
    pub reload_tx: Sender<ReloadEvent>,
    /* private fields */
}
Expand description

Shared, cheaply-clonable state behind every handler. Clone bumps the Arc/broadcast handle.

Fields§

§project_root: PathBuf§out_dir: PathBuf§docs_dir: PathBuf

Canonicalized docs/ dir — the write-guard root.

§base: String

Site base path (e.g. /docs), normalized to a leading-slash, no-trailing-slash form; empty when the site is served at the root. The built HTML prefixes every asset/nav/wikilink URL with this, so the dev server must strip it off incoming request paths before resolving them against out_dir.

§port: u16

The loopback port the server is bound to. Used by the Host-header allowlist to defeat DNS-rebinding (see handlers::loopback_guard).

§reload_tx: Sender<ReloadEvent>

Implementations§

Source§

impl AppState

Source

pub fn new( project_root: PathBuf, out_dir: PathBuf, docs_dir: PathBuf, port: u16, reload_tx: Sender<ReloadEvent>, ) -> Self

Construct an AppState. Initializes the self-write suppression clock.

Source

pub fn with_engine(self, engine: DevState) -> Self

Attach the incremental build engine. Builder-style so the new() call sites (including tests) stay untouched. Only serve_async sets one.

Source

pub fn with_base(self, base: &str) -> Self

Set the site base path, normalized to a leading-slash, no-trailing-slash form (docs / /docs/ / docs/ all become /docs; empty stays empty). Builder-style so the existing new() call sites stay untouched.

Source

pub fn note_self_write(&self)

Record that the editor just wrote a doc on disk. The watcher will skip the next change it sees within [SELF_WRITE_SUPPRESS] as a duplicate.

Source

pub fn take_self_write_suppression(&self) -> bool

Whether a watcher event right now should be suppressed as the echo of a recent editor write. Consumes the marker so only one rebuild is skipped.

Trait Implementations§

Source§

impl Clone for AppState

Source§

fn clone(&self) -> AppState

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

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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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<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