Struct bb8_tivk::Config[][src]

pub struct Config {
    pub ca_path: Option<PathBuf>,
    pub cert_path: Option<PathBuf>,
    pub key_path: Option<PathBuf>,
    pub timeout: Duration,
Expand description

The configuration for either a RawClient or a TransactionClient.

See also TransactionOptions which provides more ways to configure requests.


ca_path: Option<PathBuf>cert_path: Option<PathBuf>key_path: Option<PathBuf>timeout: Duration


impl Config[src]

pub fn with_security(
    ca_path: impl Into<PathBuf>,
    cert_path: impl Into<PathBuf>,
    key_path: impl Into<PathBuf>
) -> Config

Set the certificate authority, certificate, and key locations for clients.

By default, this client will use an insecure connection over instead of one protected by Transport Layer Security (TLS). Your deployment may have chosen to rely on security measures such as a private network, or a VPN layer to provide secure transmission.

To use a TLS secured connection, use the with_security function to set the required parameters.

TiKV does not currently offer encrypted storage (or encryption-at-rest).


let config = Config::default().with_security("", "internal.cert", "internal.key");

pub fn with_timeout(self, timeout: Duration) -> Config[src]

Set the timeout for clients.

The timeout is used for all requests when using or connecting to a TiKV cluster (including PD nodes). If the request does not complete within timeout, the request is cancelled and an error returned to the user.

The default timeout is two seconds.


let config = Config::default().with_timeout(Duration::from_secs(10));

Trait Implementations

impl Clone for Config[src]

pub fn clone(&self) -> Config[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Config[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter. Read more

impl Default for Config[src]

pub fn default() -> Config[src]

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Config where
    Config: Default

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<Config, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq<Config> for Config[src]

pub fn eq(&self, other: &Config) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

pub fn ne(&self, other: &Config) -> bool[src]

This method tests for !=.

impl Serialize for Config[src]

pub fn serialize<__S>(
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for Config[src]

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

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

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

fn in_current_span(self) -> Instrumented<Self>[src]

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

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

pub fn vzip(self) -> V

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>,