Skip to main content

Config

commonware_consensus::marshal

Struct Config 

Source 
pub struct Config<B, P, ES, T>
where
    B: Block,
    P: Provider<Scope = Epoch>,
    ES: Epocher,
    T: Strategy,
{
Show 14 fields
    pub provider: P,
    pub epocher: ES,
    pub partition_prefix: String,
    pub mailbox_size: usize,
    pub view_retention_timeout: ViewDelta,
    pub prunable_items_per_section: NonZeroU64,
    pub page_cache: CacheRef,
    pub replay_buffer: NonZeroUsize,
    pub key_write_buffer: NonZeroUsize,
    pub value_write_buffer: NonZeroUsize,
    pub block_codec_config: B::Cfg,
    pub max_repair: NonZeroUsize,
    pub max_pending_acks: NonZeroUsize,
    pub strategy: T,

}
Expand description

Marshal configuration.

§Warning

Any height the marshal is asked to sync must be covered by both the epocher and the provider. If the epocher cannot map a height to an epoch, or the provider cannot supply a scheme for that epoch, the marshal will silently drop the sync request. Callers are responsible for ensuring both are configured for the full range of heights they intend to sync.

Fields§

§provider: P

Provider for epoch-specific signing schemes.

Must cover every epoch that contains heights the marshal will sync.

§epocher: ES

Configuration for epoch lengths across block height ranges.

Must cover every height the marshal will sync.

§partition_prefix: String

The prefix to use for all partitions.

§mailbox_size: usize

Size of backfill request/response mailbox.

§view_retention_timeout: ViewDelta

Minimum number of views to retain temporary data after the application processes a block.

Useful for keeping around information that peers may desire to have.

§prunable_items_per_section: NonZeroU64

Prunable archive partition prefix.

§page_cache: CacheRef

The page cache to use for the freezer journal.

§replay_buffer: NonZeroUsize

The size of the replay buffer for storage archives.

§key_write_buffer: NonZeroUsize

The size of the write buffer for the key journal of storage archives.

§value_write_buffer: NonZeroUsize

The size of the write buffer for the value journal of storage archives.

§block_codec_config: B::Cfg

Codec configuration for block type.

§max_repair: NonZeroUsize

Maximum number of blocks to repair at once.

§max_pending_acks: NonZeroUsize

Maximum number of blocks dispatched to the application that have not yet been acknowledged. Increasing this value allows the application to buffer work while marshal continues dispatching, hiding ack latency.

§strategy: T

Strategy for parallel operations.

Auto Trait Implementations§

§

impl<B, P, ES, T> Freeze for Config<B, P, ES, T>
where P: Freeze, ES: Freeze, <B as Read>::Cfg: Freeze, T: Freeze,

§

impl<B, P, ES, T> !RefUnwindSafe for Config<B, P, ES, T>

§

impl<B, P, ES, T> Send for Config<B, P, ES, T>

§

impl<B, P, ES, T> Sync for Config<B, P, ES, T>

§

impl<B, P, ES, T> Unpin for Config<B, P, ES, T>
where P: Unpin, ES: Unpin, <B as Read>::Cfg: Unpin, T: Unpin,

§

impl<B, P, ES, T> UnsafeUnpin for Config<B, P, ES, T>
where P: UnsafeUnpin, ES: UnsafeUnpin, <B as Read>::Cfg: UnsafeUnpin, T: UnsafeUnpin,

§

impl<B, P, ES, T> !UnwindSafe for Config<B, P, ES, T>

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> 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, 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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,