Skip to main content

SkybaseConfig

Struct SkybaseConfig 

Source
pub struct SkybaseConfig {
    pub client_id: String,
    pub redirect_uri: String,
    pub app_name: String,
    pub jetstream_endpoint: Option<String>,
    pub storage_path: Option<PathBuf>,
    pub in_memory_store: bool,
    pub store_config: Option<RecordStoreConfig>,
    pub wanted_collections: Vec<String>,
    pub wanted_dids: Vec<String>,
}
Expand description

Configuration options for initializing a Skybase engine instance.

Fields§

§client_id: String

OAuth Client ID URI (e.g., <https://app.example.com/oauth/client-metadata.json>).

§redirect_uri: String

OAuth callback redirect URI (e.g., <https://app.example.com/oauth/callback>).

§app_name: String

Application display name presented during consent dialogs.

§jetstream_endpoint: Option<String>

Optional Jetstream WebSocket endpoint for real-time firehose subscription.

§storage_path: Option<PathBuf>

Optional filesystem path to SQLite database. If set, opens a persistent WAL store.

§in_memory_store: bool

Whether to open an isolated in-memory SQLite database upon initialization.

§store_config: Option<RecordStoreConfig>

Optional explicit configuration for the embedded record store.

§wanted_collections: Vec<String>

Target collection NSIDs to filter for at the edge during Jetstream ingestion.

§wanted_dids: Vec<String>

Target repository DIDs to filter for at the edge during Jetstream ingestion.

Implementations§

Source§

impl SkybaseConfig

Source

pub fn new( client_id: impl Into<String>, redirect_uri: impl Into<String>, app_name: impl Into<String>, ) -> Self

Creates a new SkybaseConfig with required OAuth parameters.

Source

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

Sets a custom Jetstream WebSocket endpoint for event subscription.

Source

pub fn with_storage_path(self, path: impl Into<PathBuf>) -> Self

Configures a persistent SQLite database file path.

Source

pub fn with_in_memory_store(self) -> Self

Configures an isolated in-memory SQLite database.

Source

pub fn with_store_config(self, config: RecordStoreConfig) -> Self

Sets an explicit RecordStoreConfig.

Source

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

Appends a target collection NSID to filter for at the edge.

Source

pub fn with_wanted_collections<I, S>(self, collections: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Sets target collection NSIDs to filter for at the edge.

Source

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

Appends a target DID to filter for at the edge.

Source

pub fn with_wanted_dids<I, S>(self, dids: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Sets target DIDs to filter for at the edge.

Trait Implementations§

Source§

impl Clone for SkybaseConfig

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 SkybaseConfig

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