Builder

Struct Builder

pub struct Builder {Show 16 fields
    pub config: Config,
    pub verifier: DynVerifier,
    pub auth_material: Option<Vec<u8>>,
    pub kitsune: DynKitsuneFactory,
    pub space: DynSpaceFactory,
    pub peer_store: DynPeerStoreFactory,
    pub bootstrap: DynBootstrapFactory,
    pub fetch: DynFetchFactory,
    pub report: DynReportFactory,
    pub transport: DynTransportFactory,
    pub op_store: DynOpStoreFactory,
    pub peer_meta_store: DynPeerMetaStoreFactory,
    pub gossip: DynGossipFactory,
    pub local_agent_store: Arc<dyn LocalAgentStoreFactory>,
    pub publish: DynPublishFactory,
    pub blocks: DynBlocksFactory,
}

Expand description

The general Kitsune2 builder. This contains both configuration and factory instances, allowing construction of runtime module instances.

Fields§

§config: Config

The module configuration to be used when building modules. This can be loaded from disk or modified before freezing the builder.

§verifier: DynVerifier

The Verifier to use for this Kitsune2 instance.

§auth_material: Option<Vec<u8>>

Any auth_material required to connect to sbd/signal and bootstrap services.

§kitsune: DynKitsuneFactory

The KitsuneFactory to be used for creating Kitsune module instances.

§space: DynSpaceFactory

The SpaceFactory to be used for creating Space instances.

§peer_store: DynPeerStoreFactory

The PeerStoreFactory to be used for creating PeerStore instances.

§bootstrap: DynBootstrapFactory

The BootstrapFactory to be used for creating Bootstrap instances for initial WAN discovery.

§fetch: DynFetchFactory

The FetchFactory to be used for creating Fetch instances.

§report: DynReportFactory

The ReportFactory to be used for creating the Report instance.

§transport: DynTransportFactory

The TransportFactory to be used for creating Transport instances.

§op_store: DynOpStoreFactory

The OpStoreFactory to be used for creating OpStore instances.

§peer_meta_store: DynPeerMetaStoreFactory

The PeerMetaStoreFactory to be used for creating PeerMetaStore instances.

§gossip: DynGossipFactory

The GossipFactory to be used for creating Gossip instances.

§local_agent_store: Arc<dyn LocalAgentStoreFactory>

The LocalAgentStoreFactory to be used for creating LocalAgentStore instances.

§publish: DynPublishFactory

The PublishFactory to be used for creating Publish instances

§blocks: DynBlocksFactory

The BlocksFactory to be used for creating Blocks instances.

Implementations§

impl Builder

pub fn with_default_config(self) -> K2Result<Self>

Construct a default config given the configured module factories.

Note, this should be called before Self::build or otherwise freezing the Builder instance in an Arc<>.

pub fn validate_config(&self) -> K2Result<()>

Validate the current configuration.

pub fn with_config_overrides(&self, overrides: Config) -> K2Result<Self>

Merge in configuration overrides.

Merged config is validated before returning.

pub async fn build(self) -> K2Result<DynKitsune>

Generate the actual kitsune instance, validating configuration if that has not already explicitly been done.

Trait Implementations§

impl Clone for Builder

fn clone(&self) -> Builder

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

impl Debug for Builder

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !Freeze for Builder

impl !RefUnwindSafe for Builder

impl Send for Builder

impl Sync for Builder

impl Unpin for Builder

impl !UnwindSafe for Builder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more