Skip to main content

TapConfig

Struct TapConfig 

Source
pub struct TapConfig {
    pub hostname: String,
    pub admin_password: Option<String>,
    pub send_acks: bool,
    pub user_agent: String,
    pub max_reconnect_attempts: Option<u32>,
    pub initial_reconnect_delay: Duration,
    pub max_reconnect_delay: Duration,
    pub reconnect_backoff_multiplier: f64,
    pub channel_buffer_size: usize,
}
Expand description

Configuration for a TAP stream connection.

Use TapConfig::builder() for ergonomic construction with defaults.

§Example

use atproto_tap::TapConfig;
use std::time::Duration;

let config = TapConfig::builder()
    .hostname("localhost:2480")
    .admin_password("secret")
    .send_acks(true)
    .max_reconnect_attempts(Some(10))
    .build();

Fields§

§hostname: String

TAP service hostname (e.g., “localhost:2480”).

The WebSocket URL is constructed as ws://{hostname}/channel.

§admin_password: Option<String>

Optional admin password for authentication.

If set, HTTP Basic Auth is used with username “admin”.

§send_acks: bool

Whether to send acknowledgments for received messages.

Default: true. Set to false if the TAP service has acks disabled.

§user_agent: String

User-Agent header value for WebSocket connections.

§max_reconnect_attempts: Option<u32>

Maximum reconnection attempts before giving up.

None means unlimited reconnection attempts (default).

§initial_reconnect_delay: Duration

Initial delay before first reconnection attempt.

Default: 1 second.

§max_reconnect_delay: Duration

Maximum delay between reconnection attempts.

Default: 60 seconds.

§reconnect_backoff_multiplier: f64

Multiplier for exponential backoff between reconnections.

Default: 2.0 (doubles the delay each attempt).

§channel_buffer_size: usize

Size of the internal channel buffer between the WebSocket reader and consumer.

A larger buffer absorbs more burst latency when the consumer has occasional slow processing. Default: 32.

Implementations§

Source§

impl TapConfig

Source

pub fn builder() -> TapConfigBuilder

Create a new configuration builder with defaults.

Source

pub fn new(hostname: impl Into<String>) -> Self

Create a minimal configuration for the given hostname.

Source

pub fn ws_url(&self) -> String

Returns the WebSocket URL for the TAP channel.

Source

pub fn http_base_url(&self) -> String

Returns the HTTP base URL for the TAP management API.

Trait Implementations§

Source§

impl Clone for TapConfig

Source§

fn clone(&self) -> TapConfig

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

impl Debug for TapConfig

Source§

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

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

impl Default for TapConfig

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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