Skip to main content

FipsEndpointBuilder

Struct FipsEndpointBuilder 

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

Builder for an embedded FIPS endpoint.

Implementations§

Source§

impl FipsEndpointBuilder

Source

pub fn config(self, config: Config) -> Self

Start from an explicit FIPS config.

Source

pub fn identity_nsec(self, nsec: impl Into<String>) -> Self

Use an nsec or hex secret for the endpoint identity.

Source

pub fn discovery_scope(self, scope: impl Into<String>) -> Self

Set an application-level discovery scope.

When the builder owns the default empty connectivity config, this also enables scoped Nostr discovery, open same-scope peer discovery, local LAN candidates, host-wide loopback rendezvous, and a UDP NAT advert. If an explicit transport or Nostr config was supplied, the explicit config is left in control and the scope is retained as endpoint metadata; call Self::local_rendezvous to opt that endpoint into same-host composition.

Source

pub fn local_rendezvous(self) -> Self

Enable host-wide authenticated loopback composition.

Source

pub fn local_role(self, name: impl Into<String>, priority: i16) -> Self

Advertise a portless same-host role, such as nostr.pubsub/1. Empty, oversized, and excess names are ignored.

Source

pub fn without_system_tun(self) -> Self

Disable FIPS-owned TUN and DNS system integration.

Source

pub fn packet_channel_capacity(self, capacity: usize) -> Self

Set the app packet/data channel capacity.

Source

pub async fn bind(self) -> Result<FipsEndpoint, FipsEndpointError>

Bind and start the embedded endpoint.

Source

pub async fn bind_with_direct_receiver( self, ) -> Result<(FipsEndpoint, FipsEndpointDirectReceiver), FipsEndpointError>

Bind with a bounded receiver for direct dataplane endpoint packet runs.

Source

pub async fn bind_with_direct_sink<S>( self, sink: S, ) -> Result<FipsEndpoint, FipsEndpointError>

Bind and start the endpoint with a direct dataplane endpoint-data sink.

Decrypted dataplane endpoint output is delivered to sink synchronously from the dataplane output path. Generic endpoint events, including loopback sends and non-dataplane delivery, continue to use the regular receive queue.

Trait Implementations§

Source§

impl Clone for FipsEndpointBuilder

Source§

fn clone(&self) -> FipsEndpointBuilder

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 FipsEndpointBuilder

Source§

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

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

impl Default for FipsEndpointBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> 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<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