Skip to main content

FileCredential

Struct FileCredential 

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

Reads a token file at construction and after its modification time or size changes.

File metadata is checked at most once per second. Surrounding whitespace is removed. If the file becomes empty or unreadable, requests fail until a later check succeeds; no stale token is sent. The constructor fails when the initial file is unreadable or empty. Checks and reads use a mutex, briefly serializing concurrent callers. Use a local filesystem; slow network filesystems can delay calls. Replace the token atomically by writing a temporary file and renaming it. An empty or partial token can fail pull stream opens, which back off for about one minute.

use std::sync::Arc;
use dex_sdk::{ClientOptions, FileCredential, WorkerOptions};
let credential = Arc::new(FileCredential::new("/var/run/secrets/dex/token")?);
let client_options = ClientOptions::new().credential(credential.clone());
let worker_options = WorkerOptions::new().credential(credential);

Implementations§

Source§

impl FileCredential

Source

pub fn new(path: impl AsRef<Path>) -> Result<Self>

Opens path and reads its initial nonempty token.

§Errors

Returns an I/O error if the file cannot be inspected or read, or contains only whitespace. See the FileCredential example for sharing the credential with a Client and Worker.

Trait Implementations§

Source§

impl Credential for FileCredential

Source§

fn token(&self) -> Result<String, CredentialError>

Returns the current bare token, or an error that fails the request locally. Read more
Source§

fn discard_rejected_token(&self, _rejected_token: &str)

Discards a token rejected by Dex if it is still the credential’s cached token. Read more
Source§

fn token_after_rejection( &self, ) -> Option<Pin<Box<dyn Future<Output = Result<String, CredentialError>> + Send + '_>>>

Supplies an asynchronous fresh token after rejection when supported. Read more
Source§

impl Debug for FileCredential

Source§

fn fmt(&self, formatter: &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> 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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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