Skip to main content

SalesforceAuthConfig

Struct SalesforceAuthConfig 

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

Configuration for the Salesforce Data Cloud token flow.

Configures how OAuth Access Tokens and DC JWTs are obtained:

  • login_url + client_id + auth_mode → OAuth Access Token
  • OAuth Access Token + dataspace → DC JWT

§Example

use hyperdb_api_salesforce::{SalesforceAuthConfig, AuthMode};

let config = SalesforceAuthConfig::new(
    "https://login.salesforce.com",
    "3MVG9...", // Connected App Consumer Key
)?
.auth_mode(AuthMode::private_key("user@example.com", &private_key_pem)?)
.dataspace("default");

Implementations§

Source§

impl SalesforceAuthConfig

Source

pub fn new( login_url: impl AsRef<str>, client_id: impl Into<String>, ) -> SalesforceAuthResult<Self>

Creates a new configuration with the given login URL and client ID.

§Arguments
§Known Login URLs
  • Production: https://login.salesforce.com
  • Sandbox: https://test.salesforce.com
  • Custom domain: https://mydomain.my.salesforce.com
§Errors

Returns SalesforceAuthError::Config if:

  • login_url cannot be parsed as a URL (converted from url::ParseError).
  • The URL scheme is not http or https.
  • The URL lacks a host component.
Source

pub fn auth_mode(self, mode: AuthMode) -> Self

Sets the authentication mode.

Source

pub fn client_secret(self, secret: impl Into<String>) -> Self

Sets the client secret (required for Password and RefreshToken modes).

Note: Client secret is NOT required for PrivateKey (JWT Bearer) mode.

Source

pub fn dataspace(self, dataspace: impl Into<String>) -> Self

Sets the Data Cloud dataspace.

Source

pub fn timeout_secs(self, secs: u64) -> Self

Sets the HTTP request timeout in seconds (default: 30).

Source

pub fn max_retries(self, retries: u32) -> Self

Sets the maximum number of retries for transient failures (default: 3).

Source

pub fn login_url(&self) -> &Url

Returns the login URL.

Source

pub fn client_id(&self) -> &str

Returns the client ID.

Source

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

Returns the dataspace, if set.

Trait Implementations§

Source§

impl Clone for SalesforceAuthConfig

Source§

fn clone(&self) -> SalesforceAuthConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SalesforceAuthConfig

Source§

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

Formats the value using the given formatter. 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> 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> 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> 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