Struct CircuitBreakerSet

pub struct CircuitBreakerSet<R = CircuitBreaker>(/* private fields */);

Implementations

impl<R> CircuitBreakerSet<R>

pub fn empty() -> Self

Returns an empty, no-op set with zero retained history.

Breakers can still be added later, but history-dependent breakers cannot trip until the set is configured with enough history capacity and samples have accumulated.

pub fn new(config: CircuitBreakerSetConfig) -> Self

pub fn set_manual_trip( &mut self, is_manually_tripped: bool, actor: AccountId, metadata: Option<Vec<u8>>, ) -> CircuitBreakerOutcome

pub fn remove( &mut self, breaker_id: u32, ) -> Result<CircuitBreakerOutcome, CircuitBreakerError>

pub fn sample_interval_ns(&self) -> Nanoseconds

pub fn accepted_history(&self) -> &RingBuffer<Observation>

pub fn observed_history(&self) -> &RingBuffer<Observation>

pub fn next_id(&self) -> u32

pub fn is_manually_tripped(&self) -> bool

pub fn breakers(&self) -> &BTreeMap<u32, CircuitBreakerState<R>>

pub fn breaker_count(&self) -> usize

pub fn is_blocking(&self) -> bool

pub fn blocking_reason(&self) -> Option<PriceBlockedReason>

impl<R: CircuitBreakerRule> CircuitBreakerSet<R>

pub fn validate(&self) -> Result<(), CircuitBreakerSetParseError>

pub fn set_config( &mut self, config: CircuitBreakerSetConfig, ) -> Result<CircuitBreakerOutcome, CircuitBreakerError>

impl CircuitBreakerSet<CircuitBreaker>

pub fn add( &mut self, breaker_id: u32, breaker: CircuitBreaker, ) -> Result<CircuitBreakerOutcome, CircuitBreakerError>

pub fn set_enforced( &mut self, breaker_id: u32, is_enforced: bool, ) -> Result<CircuitBreakerOutcome, CircuitBreakerError>

pub fn rearm( &mut self, breaker_id: u32, armed_after_ns: Nanoseconds, ) -> Result<CircuitBreakerOutcome, CircuitBreakerError>

impl<R: CircuitBreakerRule> CircuitBreakerSet<R>

pub fn try_accept_price( &mut self, price: Price, now: Nanoseconds, ) -> Result<CircuitBreakerOutcome<PriceAcceptance>, CircuitBreakerError>

Trait Implementations

impl<R: BorshDeserialize> BorshDeserialize for CircuitBreakerSet<R>

fn deserialize_reader<Reader: Read>(reader: &mut Reader) -> Result<Self>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl<R> BorshSchema for CircuitBreakerSet<R>

where R: BorshSchema,

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut BTreeMap<Declaration, Definition>, )

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl<R> BorshSerialize for CircuitBreakerSet<R>

where R: BorshSerialize,

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl<R: Clone> Clone for CircuitBreakerSet<R>

fn clone(&self) -> CircuitBreakerSet<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for CircuitBreakerSet<R>

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

Formats the value using the given formatter.

impl<'de, R> Deserialize<'de> for CircuitBreakerSet<R>

where R: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<R> From<CircuitBreakerSet<R>> for UncheckedCircuitBreakerSet<R>

fn from(value: CircuitBreakerSet<R>) -> Self

Converts to this type from the input type.

impl<R: JsonSchema> JsonSchema for CircuitBreakerSet<R>

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

impl<R: PartialEq> PartialEq for CircuitBreakerSet<R>

fn eq(&self, other: &CircuitBreakerSet<R>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R> Serialize for CircuitBreakerSet<R>

where R: Clone + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<R> TryFrom<UncheckedCircuitBreakerSet<R>> for CircuitBreakerSet<R>

type Error = CircuitBreakerSetParseError

The type returned in the event of a conversion error.

fn try_from(value: UncheckedCircuitBreakerSet<R>) -> Result<Self, Self::Error>

Performs the conversion.

impl<R: Eq> Eq for CircuitBreakerSet<R>

impl<R> StructuralPartialEq for CircuitBreakerSet<R>