Struct DatabaseUrl 

pub struct DatabaseUrl {
    pub scheme: String,
    pub host: String,
    pub port: u16,
    pub username: String,
    pub password: String,
    pub database: String,
}

DatabaseUrl represents a structured database connection URL, providing options for the scheme, host, port, username, password, and database name.

Fields

scheme: String

host: String

port: u16

username: String

password: String

database: String

Implementations

impl DatabaseUrl

pub fn new() -> Self

initializes a new instance of the db url

pub fn from_url_str<T>(url: T) -> Self

where T: AsRef<str>,

try to parse an instance from the given url

pub fn from_env(key: &str) -> Self

load and parse the database url from the configured environment variable

pub fn scheme(&self) -> &str

returns a reference to the scheme of the database url

pub fn host(&self) -> &str

returns a reference to the host of the database url

pub fn port(&self) -> u16

returns the configured port

pub fn username(&self) -> &str

returns a reference to the username

pub fn password(&self) -> &str

returns a reference to the password

pub fn database(&self) -> &str

returns a reference to the database name

pub fn set_database<T>(&mut self, database: T)

where T: ToString,

update the database name

pub fn set_host<T>(&mut self, host: T)

where T: ToString,

update the database host

pub fn set_port(&mut self, port: u16)

update the port

pub fn set_username<T>(&mut self, username: T)

where T: ToString,

set the username

pub fn set_password<T>(&mut self, password: T)

where T: ToString,

update the database password

pub fn set_scheme<T>(&mut self, scheme: T)

where T: ToString,

update the scheme of the database

pub fn with_database<T>(self, database: T) -> Self

where T: ToString,

returns a new instance with the given database name

pub fn with_host<T>(self, host: T) -> Self

where T: ToString,

returns a new instance with the given host

pub fn with_port(self, port: u16) -> Self

returns a new instance with the given port

pub fn with_username<T>(self, username: T) -> Self

where T: ToString,

returns a new instance with the given username

pub fn with_password<T>(self, password: T) -> Self

where T: ToString,

returns a new instance with the given password

pub fn with_scheme<T>(self, scheme: T) -> Self

where T: ToString,

returns a new instance with the given scheme

pub fn format(&self) -> String

returns a string representation of the url

pub fn as_url(&self) -> Url

returns the database url as a Url

Trait Implementations

impl Clone for DatabaseUrl

fn clone(&self) -> DatabaseUrl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseUrl

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

Formats the value using the given formatter.

impl Default for DatabaseUrl

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DatabaseUrl

where DatabaseUrl: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DatabaseUrl

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

Formats the value using the given formatter.

impl From<DatabaseLink> for DatabaseUrl

fn from(link: DatabaseLink) -> Self

Converts to this type from the input type.

impl From<DatabaseUrl> for DatabaseLink

fn from(url: DatabaseUrl) -> Self

Converts to this type from the input type.

impl From<DatabaseUrl> for String

fn from(url: DatabaseUrl) -> Self

Converts to this type from the input type.

impl From<DatabaseUrl> for Url

fn from(url: DatabaseUrl) -> Self

Converts to this type from the input type.

impl From<DatabaseUrl> for Value

fn from(url: DatabaseUrl) -> Self

Converts to this type from the input type.

impl From<String> for DatabaseUrl

fn from(url: String) -> Self

Converts to this type from the input type.

impl From<Url> for DatabaseUrl

fn from(url: Url) -> Self

Converts to this type from the input type.

impl From<Value> for DatabaseUrl

fn from(value: Value) -> Self

Converts to this type from the input type.

impl FromStr for DatabaseUrl

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for DatabaseUrl

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DatabaseUrl

fn cmp(&self, other: &DatabaseUrl) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq<&'a str> for DatabaseUrl

fn eq(&self, other: &&'a str) -> 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 PartialEq<String> for DatabaseUrl

fn eq(&self, other: &String) -> 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 PartialEq for DatabaseUrl

fn eq(&self, other: &DatabaseUrl) -> 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 PartialOrd for DatabaseUrl

fn partial_cmp(&self, other: &DatabaseUrl) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for DatabaseUrl

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DatabaseUrl

impl StructuralPartialEq for DatabaseUrl