Skip to main content

AdminConfig

Struct AdminConfig 

Source
pub struct AdminConfig {
    pub snapshot: Option<SnapshotAdminConfig>,
    pub wal: Option<Arc<dyn WalAdmin>>,
}
Expand description

Configuration for the admin surface. Snapshot and WAL admin are independent: each set of routes mounts only when its corresponding field is Some.

  • snapshot.is_some() mounts POST /admin/snapshot/save and POST /admin/snapshot/load against the configured path (the body’s optional path field overrides per request).
  • wal.is_some() mounts POST /admin/wal/status and POST /admin/wal/truncate unconditionally, plus POST /admin/checkpoint (which uses snapshot.path as a default when present, and otherwise requires path in the request body).

The endpoints are intentionally opt-in: exposing them without authentication on a network-reachable interface is a footgun, so the caller must explicitly construct an AdminConfig and pass it to the server — there is no implicit default path.

Fields§

§snapshot: Option<SnapshotAdminConfig>

Snapshot save/load admin. None to disable /admin/snapshot/{save,load}.

§wal: Option<Arc<dyn WalAdmin>>

WAL admin. None to disable /admin/wal/* and /admin/checkpoint.

Implementations§

Source§

impl AdminConfig

Source

pub fn snapshot_only( snapshot_path: PathBuf, admin: Arc<dyn SnapshotAdmin>, ) -> Self

Construct a snapshot-only admin config (no WAL endpoints).

Source

pub fn wal_only(wal: Arc<dyn WalAdmin>) -> Self

Construct a WAL-only admin config (no snapshot endpoints). The /admin/checkpoint route still mounts but every call needs a path in the request body since there is no configured default.

Source

pub fn is_empty(&self) -> bool

True when neither admin surface is configured. The router merge then becomes a no-op and the admin routes don’t exist.

Trait Implementations§

Source§

impl Clone for AdminConfig

Source§

fn clone(&self) -> AdminConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for AdminConfig

Source§

fn default() -> AdminConfig

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,