Skip to main content

SystemConfigDbBinding

Struct SystemConfigDbBinding 

Source
pub struct SystemConfigDbBinding { /* private fields */ }
Expand description

Product binding for the shared system config store.

A product normally has one static binding that supplies its registry and deprecated-key list. Repository code can then focus on product error mapping, authorization, and API cursor shape instead of repeatedly passing the same registry values into every call. Binding a registry does not make writes validated; see Self::upsert_prevalidated.

Implementations§

Source§

impl SystemConfigDbBinding

Source

pub const fn new( registry: &'static ConfigRegistry, deprecated_keys: &'static [&'static str], ) -> Self

Creates a product binding from a config registry and deprecated key list.

Source

pub async fn find_all<C: ConnectionTrait>(&self, db: &C) -> Result<Vec<Model>>

Lists all rows by stable id order.

§Errors

Returns an error when the database operation fails.

Source

pub async fn find_cursor<C: ConnectionTrait>( &self, db: &C, limit: u64, after_id: Option<i64>, ) -> Result<SystemConfigCursorSlice>

Lists one id-cursor page by stable id order.

§Errors

Returns an error when the database operation fails.

Source

pub async fn find_by_key<C: ConnectionTrait>( &self, db: &C, key: &str, ) -> Result<Option<Model>>

Finds one row by key.

§Errors

Returns an error when the database operation fails.

Source

pub async fn find_visible_custom<C: ConnectionTrait>( &self, db: &C, include_authenticated: bool, ) -> Result<Vec<Model>>

Lists visible custom rows ordered by key.

§Errors

Returns an error when the database operation fails.

Source

pub async fn lock_by_key<C: ConnectionTrait>( &self, db: &C, key: &str, ) -> Result<()>

Locks one row by key where the database supports row locks.

§Errors

Returns an error when the database operation fails.

Source

pub async fn upsert_prevalidated<C: ConnectionTrait>( &self, db: &C, request: SystemConfigUpsert<'_>, ) -> Result<Model>

Persists a prevalidated storage string using registry metadata for known system keys.

§Preconditions

The caller must complete structure, normalizer, and dependency validation on the logical value before constructing the request, then encode any secret storage envelope. This method writes request.value verbatim without any of those checks. Custom-key validation, authorization, and audit remain product-owned. Pass a transaction for atomic write/audit; update snapshots and notify only after commit. See upsert_prevalidated.

§Errors

Returns an error when the database operation fails.

Source

pub async fn delete_by_key<C: ConnectionTrait>( &self, db: &C, key: &str, ) -> Result<()>

Deletes a custom row.

§Errors

Returns an error when the database operation fails.

Source

pub async fn ensure_system_value_if_missing<C: ConnectionTrait>( &self, db: &C, key: &str, value: &str, ) -> Result<bool>

Inserts one system value if no row exists.

The caller must validate the logical value and encode any secret before calling. value is persisted verbatim without structure, normalizer, or dependency validation.

§Errors

Returns an error when the database operation fails.

Source

pub async fn delete_deprecated_keys<C: ConnectionTrait>( &self, db: &C, ) -> Result<u64>

Deletes deprecated system keys configured by the product.

§Errors

Returns an error when the database operation fails.

Source

pub async fn ensure_defaults<C: ConnectionTrait>(&self, db: &C) -> Result<usize>

Ensures default rows exist and repairs metadata for existing system rows.

§Errors

Returns an error when the database operation fails.

Trait Implementations§

Source§

impl Clone for SystemConfigDbBinding

Source§

fn clone(&self) -> SystemConfigDbBinding

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 Copy for SystemConfigDbBinding

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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
§

impl<T> PolicyExt for T
where T: ?Sized,

§

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
§

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more