Skip to main content

FileStoreConfig

Struct FileStoreConfig 

Source
pub struct FileStoreConfig {
    pub enabled: Option<bool>,
    pub path: Option<String>,
    pub name: Option<String>,
}
Expand description

[store] section in mcpr.toml.

Controls the SQLite-based request storage engine. All fields are optional — sensible defaults are applied based on the platform.

[store]
# Enable or disable request storage. Default: true.
# Set to false to run mcpr as a pure proxy with no local persistence.
enabled = true

# Override the database file path. Default: platform-specific.
# Linux:   ~/.local/share/mcpr/mcpr.db
# macOS:   ~/Library/Application Support/mcpr/mcpr.db
# Windows: %APPDATA%\mcpr\mcpr.db
path = "/var/lib/mcpr/requests.db"

# Proxy name tag written to every row. Default: derived from upstream URL.
# Use this when you run multiple proxies sharing one database file,
# or when you want a human-friendly name in `mcpr proxy logs <name>`.
name = "api-server"

Fields§

§enabled: Option<bool>

Whether request storage is enabled.

When false, no database is opened and no events are recorded. CLI query commands (mcpr proxy logs, etc.) will report that storage is disabled.

Default: true — storage is on by default because observability is the primary value proposition of mcpr beyond basic proxying.

§path: Option<String>

Override the database file path.

When set, the store uses this exact path instead of the platform default. Useful for:

  • Placing the DB on a specific disk or partition.
  • Docker/container deployments where the data dir is mounted.
  • Running integration tests with an isolated database.

The parent directory is created automatically if it doesn’t exist. Default: platform-specific (see super::path::resolve_db_path).

§name: Option<String>

Human-readable proxy name, written to every request and session row.

This is how mcpr proxy logs <name> identifies which proxy’s data to query. When multiple proxies share a database, each needs a unique name.

Default: derived from the upstream MCP URL hostname (e.g., “localhost-9000” for http://localhost:9000/mcp). Set this explicitly when the derived name isn’t descriptive enough.

Implementations§

Source§

impl FileStoreConfig

Source

pub fn is_enabled(&self) -> bool

Whether storage is enabled. Defaults to true.

Trait Implementations§

Source§

impl Clone for FileStoreConfig

Source§

fn clone(&self) -> FileStoreConfig

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 Debug for FileStoreConfig

Source§

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

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

impl Default for FileStoreConfig

Source§

fn default() -> FileStoreConfig

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

impl<'de> Deserialize<'de> for FileStoreConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl ModuleConfig for FileStoreConfig

Source§

fn name(&self) -> &'static str

Module name — must match the TOML section key (e.g., “store”, “cloud”, “tunnel”). Read more
Source§

fn validate(&self) -> Vec<ConfigIssue>

Validate this module’s configuration. Read more
Source§

fn apply_defaults(&mut self)

Apply runtime-aware defaults that can’t be expressed in Default::default(). 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> 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> 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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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