Struct Provider 

pub struct Provider {
    pub address: String,
    pub model: String,
    pub key_file: String,
    pub key_header: String,
    pub source: Source,
}

The provider as the settings describe it. Every field is what the person wrote, trimmed.

Fields

address: String

The address the Messages API lives under.

model: String

The model asked for.

key_file: String

The path of the key file, as written: ~/ stands for the home folder.

key_header: String

The header the key goes in.

source: Source

Where all this was described.

Implementations

impl Provider

pub fn from_settings(settings: &Settings) -> Self

The provider in settings.

pub fn from_environment( read: impl Fn(&str) -> Option<String>, ) -> Result<Option<Self>, ProfileError>

The provider a QCode profile describes in the environment read gives, None when it describes none, which is qcli started anywhere but in a QCode tab.

Errors

When only one of the two variables is set, or the address is not one of this machine.

pub fn write(&self, settings: &mut Settings)

Writes the provider into settings. A header that is the default is not written, the way the ecosystem writes no default. A provider a QCode profile described is never written: it is the profile’s, and the person’s own settings stay as they wrote them.

pub fn missing_field(&self) -> Option<&'static str>

The first empty field, if any: the provider cannot be asked without all of them. A profile’s provider has no key file to miss.

pub fn key_path(&self) -> PathBuf

The key file’s path, with ~/ read as the home folder.

pub fn endpoint(&self) -> Result<Endpoint, Missing>

The endpoint to ask, with the key read from its file now; a profile’s provider is asked with no key, which its relay adds.

Errors

When a field is empty or the key file gives no key.

Trait Implementations

impl Clone for Provider

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Provider

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

Formats the value using the given formatter.

impl Default for Provider

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Provider

impl PartialEq for Provider

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Provider