Builder

Struct Builder 

Source
pub struct Builder { /* private fields */ }
Expand description

Fluent API for configuring a client.

Implementations§

Source§

impl Builder

Source

pub fn set_custom_auth(&mut self, auth: AuthHeaderManager) -> &mut Self

Set a custom authenticator.

§Arguments
  • auth - Authenticator to use.
Source

pub fn set_oidc_credentials(&mut self, auth: AuthenticatorConfig) -> &mut Self

Set an authenticator using OIDC client credentials.

§Arguments
  • auth - Client credentials.
Source

pub fn set_project(&mut self, project: &str) -> &mut Self

Set the CDF project to connect to.

§Arguments
  • project - CDF project
Source

pub fn set_app_name(&mut self, app_name: &str) -> &mut Self

Set the value of the x-cdp-app header.

Source

pub fn set_internal_client(&mut self, client: Client) -> &mut Self

Set the reqwest client used internally. If your application connects to a large number of different CDF projects, or uses a large number of different sets of credentials. It is recommended to share a single reqwest client.

§Arguments
  • client - reqwest client to use.
Source

pub fn set_client_config(&mut self, config: ClientConfig) -> &mut Self

Set configuration for retries.

§Arguments
  • config - Client configuration.
Source

pub fn set_base_url(&mut self, base_url: &str) -> &mut Self

Set the base URL used by the client.

§Arguments
  • base_url - Cognite API base URL, for example https://api.cognitedata.com
Source

pub fn with_custom_middleware( &mut self, middleware: Arc<dyn Middleware>, ) -> &mut Self

Add some custom middleware.

§Arguments
  • middleware - A reference to some reqwest middleware.
Source

pub fn build(self) -> Result<CogniteClient>

Create a cognite client. This may fail if not all required parameters are provided.

Trait Implementations§

Source§

impl Default for Builder

Source§

fn default() -> Builder

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

Auto Trait Implementations§

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> 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> IntoPatchItem<UpdateSet<T>> for T

Source§

fn patch(self, _options: &UpsertOptions) -> Option<UpdateSet<T>>

Convert self into a patch, optionally ignoring null values.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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