Skip to main content

PluginAuth

Struct PluginAuth 

Source
pub struct PluginAuth {
    pub provider: String,
    pub id: String,
    pub file_name: String,
    pub label: String,
    pub prefix: String,
    pub proxy_url: String,
    pub disabled: bool,
    pub storage_json: Bytes,
    pub metadata: Metadata,
    pub attributes: StringMap,
    pub next_refresh_after: GoTime,
}
Expand description

Go coreauth.Auth as a plugin produces it.

Fields§

§provider: String§id: String§file_name: String§label: String§prefix: String§proxy_url: String§disabled: bool§storage_json: Bytes

The plugin’s raw storage JSON (pluginTokenStorage.rawJSON).

§metadata: Metadata

Host-managed metadata; always carries type.

§attributes: StringMap§next_refresh_after: GoTime

Implementations§

Source§

impl PluginAuth

Source

pub fn from_auth_data( data: AuthData, path: &str, file_name: &str, auth_dir: &str, ) -> Option<Self>

Go pluginAuthDataToCoreAuth. None without a provider.

Source

pub fn storage_payload(&self) -> Result<Bytes, String>

Go mergedStorageJSON (pluginTokenStorage.RawJSON / SaveTokenToFile): the raw storage object, overlaid with metadata, type set, legacy keys normalized, encoded with sorted keys.

Source§

impl PluginAuth

Source

pub fn merge_existing(&mut self, existing: &Map<String, Value>)

Go MergeExistingAuthMetadata: keys the auth does not set are taken from the existing file’s JSON (token payload keys excepted), and its disabled unless the auth sets one.

Source

pub fn file_path(&self, base_dir: &str) -> Result<String, String>

Go resolveAuthPath: the file Self::save_file writes.

Source

pub fn save_file(self, base_dir: &str, create: bool) -> Result<String, String>

Go FileTokenStore.Save for a plugin auth: the file under base_dir (or the auth’s own path), written atomically with mode 0600 unless it already holds the same JSON. Returns the path; without create (Go’s auth creation intent, which logins carry and command-line plugins do not) a disabled auth whose file does not exist is skipped with an empty path.

Source§

impl PluginAuth

Source

pub fn view(&self) -> AuthView

The credential as the host reads it back: Go storageJSONFromAuth takes the storage’s RawJSON, which is PluginAuth::storage_payload (empty on error).

Trait Implementations§

Source§

impl Clone for PluginAuth

Source§

fn clone(&self) -> Self

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 PluginAuth

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PluginAuth

Source§

fn default() -> Self

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

impl PartialEq for PluginAuth

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PluginAuth

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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