AuthConfig

Struct AuthConfig 

Source
pub struct AuthConfig {
    pub api_key: Option<String>,
    pub secret_key: Option<String>,
}
Expand description

Authentication configuration

Configures how the client authenticates with the Noah API. Supports API key authentication, JWT signing, or both.

§Examples

use noah_sdk::AuthConfig;

// API key only
let auth = AuthConfig::with_api_key("your-api-key".to_string());

// JWT signing only
let auth = AuthConfig::with_secret_key("your-secret-key".to_string());

// Both methods
let auth = AuthConfig::with_both(
    "your-api-key".to_string(),
    "your-secret-key".to_string()
);

Fields§

§api_key: Option<String>

API key for X-Api-Key header

§secret_key: Option<String>

Secret key for JWT signing

Implementations§

Source§

impl AuthConfig

Source

pub fn with_api_key(api_key: String) -> Self

Create new auth config with API key only

This method uses simple API key authentication via the X-Api-Key header.

§Arguments
  • api_key - Your Noah API key
§Examples
use noah_sdk::AuthConfig;

let auth = AuthConfig::with_api_key("your-api-key".to_string());
Source

pub fn with_secret_key(secret_key: String) -> Self

Create new auth config with JWT secret key only

This method uses JWT signing for authentication. The client will automatically generate and sign JWTs for each request using the Api-Signature header.

§Arguments
  • secret_key - Your Noah secret key for JWT signing
§Examples
use noah_sdk::AuthConfig;

let auth = AuthConfig::with_secret_key("your-secret-key".to_string());
Source

pub fn with_both(api_key: String, secret_key: String) -> Self

Create new auth config with both API key and secret key

This method uses both API key authentication and JWT signing. Both headers will be included in requests.

§Arguments
  • api_key - Your Noah API key
  • secret_key - Your Noah secret key for JWT signing
§Examples
use noah_sdk::AuthConfig;

let auth = AuthConfig::with_both(
    "your-api-key".to_string(),
    "your-secret-key".to_string()
);

Trait Implementations§

Source§

impl Clone for AuthConfig

Source§

fn clone(&self) -> AuthConfig

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 AuthConfig

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<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