Struct TopicAdmittanceContext 

#[non_exhaustive]
pub struct TopicAdmittanceContext {
    pub dry_run: bool,
}

The context of one TopicManager::identify_admissible_outputs call: the reference’s fifth argument, under its name (context?: TopicAdmittanceContext, ts-stack packages/overlays/overlay/src/TopicManager.ts at f999e0c1a).

#[non_exhaustive]: build it from TopicAdmittanceContext::default() (a real admission) or TopicAdmittanceContext::DRY_RUN, so a later field is not a breaking change for a manager.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dry_run: bool

true: the engine is only ASKING what the manager would admit (the GASP walk over a peer’s node, the anchor replay of a peer’s graph) and nothing is admitted on this call. The manager must leave NO durable trace: no storage write, no head advance, no counter an operator reads as an admission. The reference’s dryRun.

false (the default): a submit. What the manager admits here the engine goes on to store.

Implementations

impl TopicAdmittanceContext

pub const DRY_RUN: Self

The context of a dry run (dry_run: true).

Trait Implementations

impl Clone for TopicAdmittanceContext

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TopicAdmittanceContext

impl Debug for TopicAdmittanceContext

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

Formats the value using the given formatter.

impl Default for TopicAdmittanceContext

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TopicAdmittanceContext

impl PartialEq for TopicAdmittanceContext

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TopicAdmittanceContext