Struct ConnectionUrl 

pub struct ConnectionUrl<'a> { /* private fields */ }

A parsed database connection URL.

Connection URLs use the common <scheme>:<target>?<query> form, but the target is interpreted by the selected database driver. Network drivers use the conventional //user:password@host:port/path target. File-backed drivers use file_path, which treats // as an optional marker and keeps the following text as the path.

This distinction allows connection strings such as sqlite://todos.db and sqlite://:memory: without interpreting todos.db or :memory: as a host.

Implementations

impl<'a> ConnectionUrl<'a>

pub fn parse(value: &'a str) -> Result<Self>

Parses a database connection URL.

This validates the scheme. Drivers validate the target and query parameters they support.

pub fn as_str(&self) -> &'a str

Returns the connection URL exactly as supplied.

pub fn scheme(&self) -> &'a str

Returns the URL scheme without the trailing colon.

pub fn has_scheme(&self, expected: &str) -> bool

Returns true when the URL uses expected.

URL schemes are ASCII case-insensitive.

pub fn path(&self) -> &'a str

Returns the path component of an authority-based connection URL.

For postgresql://localhost/mydb, this returns /mydb. Use file_path for SQLite and other file-backed drivers.

pub fn decoded_path(&self) -> Result<Cow<'a, str>>

Returns the percent-decoded path component.

pub fn file_path(&self) -> Result<PathBuf>

Returns the file path named by a file-backed connection URL.

The optional // after the scheme is discarded, a query string is not part of the path, and # remains a normal filename character. The path is percent-decoded before it is returned.

pub fn username(&self) -> Result<Option<Cow<'a, str>>>

Returns the percent-decoded username from the authority component.

pub fn password(&self) -> Option<Cow<'a, [u8]>>

Returns the percent-decoded password bytes from the authority component.

pub fn host(&self) -> Result<Option<&'a str>>

Returns the host from the authority component.

Brackets around an IPv6 address are not included.

pub fn port(&self) -> Result<Option<u16>>

Returns the port from the authority component.

pub fn validate_authority(&self) -> Result<()>

Validates the host and port syntax of an authority component.

URLs without an authority component are valid.

pub fn query_pairs( &self, ) -> impl Iterator<Item = (Cow<'a, str>, Cow<'a, str>)> + '_

Iterates over the percent-decoded query parameters.

Query components use form encoding, so + decodes to a space.

pub fn redact_password(&self) -> Cow<'a, str>

Returns the URL with an authority password replaced by ***.

Trait Implementations

impl<'a> Clone for ConnectionUrl<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ConnectionUrl<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for ConnectionUrl<'a>

fn eq(&self, other: &ConnectionUrl<'a>) -> 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<'a> Copy for ConnectionUrl<'a>

impl<'a> Eq for ConnectionUrl<'a>

impl<'a> StructuralPartialEq for ConnectionUrl<'a>