Config

Struct Config 

Source
pub struct Config { /* private fields */ }

Implementations§

Source§

impl Config

Source

pub fn default_server_name(&self) -> Option<&str>

Source

pub fn add_server( &mut self, host: String, protocol: String, ecdsa_public_key: Option<String>, nickname: Option<String>, ) -> Result<()>

Add a ServerConfig to the home configuration.

Returns an Err on name conflict, i.e. if a ServerConfig with the nickname or host already exists.

Callers should call Config::save afterwards to ensure modifications are persisted to disk.

Source

pub fn set_default_server( &mut self, nickname_or_host_or_url: &str, ) -> Result<()>

Set the default server in the home configuration.

Returns an Err if nickname_or_host_or_url does not refer to an existing ServerConfig in the home configuration.

Callers should call Config::save afterwards to ensure modifications are persisted to disk.

Source

pub fn remove_server(&mut self, nickname_or_host_or_url: &str) -> Result<()>

Delete a ServerConfig from the home configuration.

Returns an Err if nickname_or_host_or_url does not refer to an existing ServerConfig in the home configuration.

Callers should call Config::save afterwards to ensure modifications are persisted to disk.

Source

pub fn get_host_url(&self, server: Option<&str>) -> Result<String>

Get a URL for the specified server.

Returns the URL of the default server if server is None.

If server is Some and is a complete URL, including protocol and hostname, returns that URL without accessing the configuration.

Returns an Err if:

  • server is Some, but not a complete URL, and the supplied name does not refer to any server in the configuration.
  • server is None, but the configuration does not have a default server.
Source

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

Get the hostname of the specified server.

Returns the hostname of the default server if server is None.

If server is Some and is a complete URL, including protocol and hostname, returns that hostname without accessing the configuration.

Returns an Err if:

  • server is Some, but not a complete URL, and the supplied name does not refer to any server in the configuration.
  • server is None, but the configuration does not have a default server.
Source

pub fn protocol<'a>(&'a self, server: Option<&'a str>) -> Result<&'a str>

Get the protocol of the specified server, either "http" or "https".

Returns the protocol of the default server if server is None.

If server is Some and is a complete URL, including protocol and hostname, returns that protocol without accessing the configuration. In that case, the protocol is not validated.

Returns an Err if:

  • server is Some, but not a complete URL, and the supplied name does not refer to any server in the configuration.
  • server is None, but the configuration does not have a default server.
Source

pub fn server_configs(&self) -> &[ServerConfig]

Source

pub fn load(home_path: CliTomlPath) -> Result<Self>

Source

pub fn save(&self)

Source

pub fn server_decoding_key(&self, server: Option<&str>) -> Result<DecodingKey>

Source

pub fn server_nick_or_host<'a>( &'a self, server: Option<&'a str>, ) -> Result<&'a str>

Source

pub fn server_fingerprint(&self, server: Option<&str>) -> Result<Option<&str>>

Source

pub fn set_server_fingerprint( &mut self, server: Option<&str>, new_fingerprint: String, ) -> Result<()>

Source

pub fn edit_server( &mut self, server: &str, new_nickname: Option<&str>, new_host: Option<&str>, new_protocol: Option<&str>, ) -> Result<(Option<String>, Option<String>, Option<String>)>

Source

pub fn delete_server_fingerprint(&mut self, server: Option<&str>) -> Result<()>

Source

pub fn set_web_session_token(&mut self, token: String)

Source

pub fn set_spacetimedb_token(&mut self, token: String)

Source

pub fn clear_login_tokens(&mut self)

Source

pub fn web_session_token(&self) -> Option<&String>

Source

pub fn spacetimedb_token(&self) -> Option<&String>

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T