Struct DatabaseConfig 

pub struct DatabaseConfig {
    pub database_type: String,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub ssl: bool,
    pub connection_timeout: u16,
    pub response_timeout: u16,
    pub number_of_retries: usize,
    pub exponent_base: u64,
    pub max_delay: u64,
    pub factor: u64,
}

Configuration for database connections.

Notes

If database_type is "redis", it requires Redis version 6.2 or higher for correct operation.

Fields

database_type: String

The database type.

host: Option<String>

The database host address. If None, the typical default should be used.

port: Option<u16>

The database port. If None, the typical default should be used.

username: Option<String>

The account username for the database connection.

password: Option<String>

The account password for the database connection.

ssl: bool

If the database should use an SSL-enabled connection.

connection_timeout: u16

The timeout (in seconds) to wait for a new connection.

response_timeout: u16

The timeout (in seconds) to wait for a response.

number_of_retries: usize

The number of retry attempts with exponential backoff for connection attempts.

exponent_base: u64

The base value for exponential backoff calculation.

max_delay: u64

The maximum delay between retry attempts (in seconds).

factor: u64

The multiplication factor for retry delay calculation.

Trait Implementations

impl Clone for DatabaseConfig

fn clone(&self) -> DatabaseConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseConfig

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

Formats the value using the given formatter.

impl Default for DatabaseConfig

fn default() -> Self

Creates a new default DatabaseConfig instance.

impl<'de> Deserialize<'de> for DatabaseConfig

where DatabaseConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for DatabaseConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for DatabaseConfig

type Target = DatabaseConfig

The Python output type

type Output = Bound<'py, <DatabaseConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for DatabaseConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for DatabaseConfig

const NAME: &str = "DatabaseConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DatabaseConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for database connections. /// /// # Notes /// /// If `database_type` is `"redis"`, it requires Redis version 6.2 or higher for correct operation.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<DatabaseConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<DatabaseConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForDatabaseConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for DatabaseConfig

const TEXT_SIGNATURE: &'static str = "(database_type=None, host=None, port=None, username=None, password=None, ssl=None, connection_timeout=None, response_timeout=None, number_of_retries=None, exponent_base=None, max_delay=None, factor=None)"

impl PyStubType for DatabaseConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for DatabaseConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for DatabaseConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for DatabaseConfig

impl Eq for DatabaseConfig

impl StructuralPartialEq for DatabaseConfig