Skip to main content

SchemaTable

Struct SchemaTable 

Source
pub struct SchemaTable<'a> { /* private fields */ }
Expand description

Validated logical table bound to the merged auth schema.

Use this handle to validate field names and map adapter records back to logical keys. Execute queries with the normal adapter types (FindOne, Create, …) using SchemaTable::model.

Implementations§

Source§

impl<'a> SchemaTable<'a>

Source

pub fn new( schema: &'a DbSchema, logical_name: &str, ) -> Result<Self, RustAuthError>

Source

pub fn model(&self) -> &str

Logical model name used in adapter queries ("user", "session", …).

Source

pub fn logical_name(&self) -> &str

Source

pub fn physical_name(&self) -> Result<&str, RustAuthError>

Source

pub fn create(&self) -> Create

Source

pub fn where_eq( &self, field: &str, value: DbValue, ) -> Result<Where, RustAuthError>

Build a predicate on a logical field name (defaults to equality).

Source

pub fn where_op( &self, field: &str, operator: WhereOperator, value: DbValue, ) -> Result<Where, RustAuthError>

Build a predicate on a logical field name with an explicit operator.

Source

pub fn sort_by( &self, field: &str, direction: SortDirection, ) -> Result<Sort, RustAuthError>

Source

pub fn ensure_field(&self, logical_field: &str) -> Result<(), RustAuthError>

Validate logical field names exist in the schema.

Source

pub fn ensure_fields<const N: usize>( &self, fields: [&str; N], ) -> Result<(), RustAuthError>

Source

pub fn with_data( &self, create: Create, field: &str, value: DbValue, ) -> Result<Create, RustAuthError>

Attach a column value to a create builder using a logical field name.

Source

pub fn with_update_data( &self, update: Update, field: &str, value: DbValue, ) -> Result<Update, RustAuthError>

Attach a column value to an update builder using a logical field name.

Source

pub fn map_record(&self, record: DbRecord) -> Result<DbRecord, RustAuthError>

Map a database record’s physical column keys to logical field names.

Trait Implementations§

Source§

impl<'a> Clone for SchemaTable<'a>

Source§

fn clone(&self) -> SchemaTable<'a>

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

impl<'a> Debug for SchemaTable<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for SchemaTable<'a>

§

impl<'a> RefUnwindSafe for SchemaTable<'a>

§

impl<'a> Send for SchemaTable<'a>

§

impl<'a> Sync for SchemaTable<'a>

§

impl<'a> Unpin for SchemaTable<'a>

§

impl<'a> UnsafeUnpin for SchemaTable<'a>

§

impl<'a> UnwindSafe for SchemaTable<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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, 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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