Skip to main content

TxOptions

Struct TxOptions 

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

What a transaction is opened with: the parts of transaction control the three engines do not agree on.

Defaults to “whatever the engine’s own default is” on every axis, so Transaction::begin_on_with with a default TxOptions sends exactly what Transaction::begin_on sends.

Implementations§

Source§

impl TxOptions

Source

pub const fn new() -> Self

No option set: the engine’s own defaults.

Source

pub const fn isolation(self, level: Isolation) -> Self

Ask for an isolation level.

Source

pub const fn access(self, mode: Access) -> Self

Ask for an access mode.

Source

pub const fn read_only(self) -> Self

Shorthand for Access::ReadOnly.

Source

pub const fn sqlite_begin(self, mode: SqliteBegin) -> Self

SQLite’s begin mode. An error on any other family.

Source

pub const fn get_isolation(self) -> Option<Isolation>

The isolation level asked for, if any.

Source

pub const fn get_access(self) -> Option<Access>

The access mode asked for, if any.

Source

pub const fn get_sqlite_begin(self) -> Option<SqliteBegin>

The SQLite begin mode asked for, if any.

Source

pub fn check(&self, family: Family) -> Result<(), ExecError>

Can this engine honour these options? Answers without opening a transaction — backends call it before checking a connection out, and callers can pre-flight a configuration with it.

Source

pub fn plan(&self, family: Family) -> Result<Vec<String>, ExecError>

The exact statements Transaction::begin_on_with will run, in order, on the transaction’s own connection — or the error explaining why this engine cannot be asked for this.

Nothing here is inferred at run time from a server version; it is the documented grammar of each engine, and it is public so that “what does keelson actually send?” is answerable without a packet capture.

PostgreSQLMySQL / InnoDBSQLite
READ UNCOMMITTEDrefused (accepted by the server, run as READ COMMITTED)yesrefused
READ COMMITTEDyes (default)yesrefused
REPEATABLE READyesyes (default)refused
SERIALIZABLEyesyesyes — SQLite’s only level
READ ONLYyesyesrefused (PRAGMA query_only is connection state)
SqliteBeginrefusedrefusedyes

The rule behind every refusal: a level is accepted only when the engine runs the transaction at that level. Substituting a neighbouring level would satisfy the SQL standard (it permits running stricter than asked) and would still be a lie to the caller, who asked in order to get particular behaviour.

The match on Family is exhaustive on purpose: a new family cannot be added to this crate without deciding what it does here.

Trait Implementations§

Source§

impl Clone for TxOptions

Source§

fn clone(&self) -> TxOptions

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

Source§

impl Debug for TxOptions

Source§

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

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

impl Default for TxOptions

Source§

fn default() -> TxOptions

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

impl Eq for TxOptions

Source§

impl From<Access> for TxOptions

Source§

fn from(mode: Access) -> Self

Converts to this type from the input type.
Source§

impl From<Isolation> for TxOptions

Source§

fn from(level: Isolation) -> Self

Converts to this type from the input type.
Source§

impl From<SqliteBegin> for TxOptions

Source§

fn from(mode: SqliteBegin) -> Self

Converts to this type from the input type.
Source§

impl Hash for TxOptions

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for TxOptions

Source§

fn eq(&self, other: &TxOptions) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TxOptions

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