Struct Connection

pub struct Connection { /* private fields */ }

Connection details for script clients.

Defines the credentials, hostname and database to connect to.

Implementations

impl Connection

pub fn new( hostname: impl Into<String>, database: impl Into<String>, username: impl Into<String>, password: impl Into<String>, ) -> Connection

Creates a new connection.

Will use the HTTPS by default, unless changes.

Examples

use fm_script_client::Connection;

let connection = Connection::new("example.com", "test_sb", "foo", "bar");

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

Configures an alternative port to use.

pub fn without_tls(self, disable_tls: bool) -> Self

Disables TLS which forces the client to fall back to HTTP.

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Connection

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

Formats the value using the given formatter.

impl TryFrom<&str> for Connection

fn try_from(url: &str) -> Result<Self, Self::Error>

Converts a &str into a Connection.

Connection strings must follow this format:

https://username:password@example.com/database

Examples

use fm_script_client::Connection;

let connection: Connection = "https://username:password@example.com/database"
    .try_into()
    .unwrap();

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<String> for Connection

fn try_from(url: String) -> Result<Self, Self::Error>

Converts a String into a Connection.

Connection strings must follow this format:

https://username:password@example.com/database

Examples

use fm_script_client::Connection;

let connection: Connection = "https://username:password@example.com/database".to_string()
    .try_into()
    .unwrap();

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Url> for Connection

fn try_from(url: Url) -> Result<Self, Self::Error>

Converts a Url into a Connection.

URLs must contain a hostname, username and password, as well as a database as the path portion.

Examples

use fm_script_client::Connection;
use url::Url;

let connection: Connection = Url::parse("https://username:password@example.com/database")
    .unwrap()
    .try_into()
    .unwrap();

type Error = Error

The type returned in the event of a conversion error.